βοΈ Documentation
Eask includes a comprehensive user guide. Please try to extend it accordingly while you implement new features.
The documentation is written in Markdown, using Hugo and GitHub Pages. The former is the static site generator, and the latter is the static web pages hosting service from GitHub.
Noteπ‘ You can find all our documentation under the docs/content/ folder.
To make changes to documentation, you should have:
- hugo executable; the static site generator.
To set up the website locally, you need to first install the theme:
# Clone the repository with submodules...
git clone https://github.com/emacs-eask/cli --recurse-submodules
# Navgiate to `docs/theme/geekdoc` folder
cd ./docs/theme/geekdoc/
# Build the themes
npm install && npm run build
Then run the hugo command:
# Navigate back to `docs` folder
cd ./docs/
# Run hugo server locally
hugo server
You should see something similar to the following screen:
Start building sites β¦
hugo v0.148.1-98ba786f2f5dca0866f47ab79f394370bcb77d2f windows/amd64 BuildDate=2025-07-11T12:56:21Z VendorInfo=gohugoio
β EN β ZH - TW
βββββββββββββββββββΌββββββΌβββββββββ
Pages β 36 β 34
Paginator pages β 0 β 0
Non-page files β 2 β 0
Static files β 144 β 144
Processed images β 0 β 0
Aliases β 2 β 1
Cleaned β 0 β 0
Built in 3987 ms
Environment: "development"
Serving pages from disk
Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop
And that’s it! Now you can open the browser with the URL localhost:1313. π
Noteπ‘ You can specify -D option if you consider writing a draft.