All4Ling Website

This is a static site using a Hugo template called Doks, forked from https://github.com/h-enk/doks.

Setup

Locally installed dependencies

1. Install nodejs
2. Make sure the installation was successful and npm is available: node -v && npm -v
3. cd to the root of this repository and run npm install. This will install Hugo and all the other necessary dependencies.

Starting the server

npm run start

Docker-ized environment

1. Install docker
2. Install docker-compose

Starting the server

docker-compose up

Deploy

1. To deploy, push your commits to master.

This will trigger .gitlab-ci.yml, which will deploy the website to a GitLab page located at https://commul.pages.scientificnet.org/all4ling/www/, and reverse proxied at https://all4ling.eurac.edu.

Why Doks?

Nine main reasons why you should use Doks:

1. Security aware. Get A+ scores on Mozilla Observatory out of the box. Easily change the default Security Headers to suit your needs.

2. Fast by default. Get 100 scores on Google Lighthouse by default. Doks removes unused css, prefetches links, and lazy loads images.

3. SEO-ready. Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the SEO settings to your liking.

4. Development tools. Code with confidence. Check styles, scripts, and markdown for errors and fix automatically or manually.

5. Bootstrap framework. Build robust, flexible, and intuitive websites with Bootstrap 5. Easily customize your Doks site with the source Sass files.

6. Netlify-ready. Deploy to Netlify with sensible defaults. Easily use Netlify Functions, Netlify Redirects, and Netlify Headers.

7. Full text search. Search your Doks site with FlexSearch. Easily customize index settings and search options to your liking.

8. Page layouts. Build pages with a landing page, blog, or documentation layout. Add custom sections and components to suit your needs.

9. Dark mode. Switch to a low-light UI with the click of a button. Change colors with variables to match your branding.

Other features

• Multilingual and i18n support
• Versioning documentation support
• KaTeX math typesetting
• Mermaid diagrams and visualization
• highlight.js syntax highlighting

Requirements

• Git — latest source release
• Node.js — latest LTS version or newer

Why Node.js?

Doks uses npm (included with Node.js) to centralize dependency management, making it easy to update resources, build tooling, plugins, and build scripts.

Get started

Start a new Doks project in three steps:

1. Install dependencies

npm install

2. Start development server

npm run start

Other commands

Doks comes with commands for common tasks.

Documentation

• Netlify
• Hugo
• Doks

Communities

• Netlify Community
• Hugo Forums
• Doks Discussions

Thanks

Thanks to Netlify for providing the hosting infrastructure.

Thanks to Algolia for providing the documentation search.

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.

Backers

Support this project by becoming a backer. Your avatar will show up here.