Eleventy template project with multilingual support, search and more!
See live on
- Multi-language support
- Syntax highlighting with Prism
- Integration with Algolia (autocomplete search box)
- Google Analytics
- Edit on GitLab / GitHub
- Generation of
robots.txtandsitemap.xml - GitHub Actions script to deploy on GitHub Pages
- GitLab-CI script to deploy on GitLab Pages
- CLI tool to initialize site and generate skeleton content file
A theme is a collection of templates (under the _includes folder) that generates a specific type of content. An example is the Technology Radar, which renders a page for the radar and a page for each of the blips.
- Technology Radar. For more detail see ./src/_includes/radar/
- (NEW) Product Catalog - Catalog of products, with search.
- (NEW) API Browser - OpenAPI browser, based on Swagger UI.
Fundamenty is possible thanks to these and other wonderful open source projects.
Minimal prerequisite is node. Although latest version of node comes with npm package manager, I recommend using yarn.
- Clone the project
$ git clone git@github.com:creasoft-dev/fundamenty.git <mysite>You can also download.
$ curl https://github.com/creasoft-dev/fundamenty/archive/refs/heads/main.zip -L -o fundamenty.zip- Then install dependencies.
$ yarn install
# or
$ npm install-
Modify the file
fundamenty.site.ymlaccordingly. -
And finally, run the site initialization script.
$ yarn fun-cli site/init --deletegitNote: I you cloned the project, the
--deletegitargument will delete the.gitdirectory.
The initialization script will generate two files: ./src/_data/site.json.gen and ./.env.gen. You should rename those
files by removing the .gen extension.
To build and serve locally for development
$ yarn serveIf you are using npm you can replace yarn build with npm run build.
This project includes scripts to automatically deploy on GitHub Pages and GitLab Pages. GitHub uses .github\workflows\deploy-gh-pages.yml, and GitLab uses .gitlab-ci.yml respectively.
But you can also deploy on other SSG hosting providers such Netlify, Vercel, Firebase, or surge.sh.
You may provide the following environment variables for the deployment.
WEB_ROOT_URL- Website's root URL, used to generate site.xmlWEB_PATH_PREFIX- The URL context path. Needed when site lives in non-root path.GOOGLE_TAG_ID- Google Analytics tag ID (it starts withUA-)ALGOLIA_APP_ID- Algolia's APP IDALGOLIA_INDEX_NAME- Algolia's Index nameALGOLIA_SEARCH_API_KEY- Algolia's Search only API KeyALGOLIA_ADMIN_API_kEY- Algolia's Admin API Key (for pushing posts to Algolia index)DISQUS_SITE_NAME- Disqus' site name, for commenting.
Note: The
WEB_PATH_PREFIXvariable is for the prefix path, which is required if your site lives in a different subdirectory. Needed for GitLab/GitHub Pages. The rest of the variables are optional. If not provided, the feature will just be disabled.
Build with the following command
$ docker build -t api-portal:0.2 .Run with the following command
$ docker run -it --rm -d -p 8080:80 --name api-portal api-portal:0.2Then create site pages under ./src/{lang}/pages, and articles/posts under ./src/{lang}/posts.
Those two location includes directory data files with contextual data fields locale and tags.
The top menu can be customized by modifying the file in ./src/_data/l10n/menu_{lang}.json.
When you have links to local asset use the url filter, e.g. {{ yourUrl | url }}
Fundamenty content is organized by language. For example all English content is under ./src/en directory.
The list of available locales are defined in src/_data/site.json file.
The localization resources, aka language bundles, are located in ./src/_data/l10n directory.
Based on the list of languages, the Eleventy generates post collections per each locale, which can be accessed by the name: collections.posts_{lang}.
If you want to have segregated collections by language of other collections, you will need to add them in
.eleventy.jsfile.
The site content is under ./src.
├───{lang} - Contents in given locale
│ ├ {lang}.json - Common front matter for all the contents in Spanish
│ ├── pages - Site pages
│ ├── posts - Site posts (e.g. blog articles)
│ ├── products - Product catalog
│ └── radar - (Technology) Radar
├───images - Images
├───scripts
│ ├─ main.js - Main JS file webapack uses to build the asset bundle.
│ └─ algolia.js - Site posts (blog articles)
├───styles - Tailwind's CSS styling
├───_data - Data/configuration file.
│ ├─ site.js - Main site configuration data.
│ ├──l10n - localization resource bundles
└───_includes - Eleventy's inclusion files, as specified in the front matter
├─ apibrowser - API spec (Swagger) browser
├─ products - Product Catalog layout (Architecture Repository)
├─ layout - Default layouts
└─radar - Technology Radar layout
You can use fundamenty-cli tool to create scaffolding files.
For example, to create a post:
$ yarn fun-cli post/item "My Post Title" -l en
Will generate under /src/en/posts/yyyy-mm-dd-my-post-title.md file. Then just populate the front matter and the body with Markdown.
Fore more advanced Eleventy, read its documentation.
Especially the documentation on data is useful.
- Add more scripts to
tools/fundamenty-cli.js. - Add
markdownclassname to markdown generated tags. - Add integration with self-hosted open source commenting.
- Initial project setup Eleventy+Webpack and Eleventy+Tailwind from statickit.com.
- Theme based on Tailwind Help-Article from tailwindtoolbox
- Multilingual based on this article by Jérôme Coupé.
- Integration with Algolia based on this article and this other
- GitHub Actions for GitHub Pages