Eask includes a comprehensive user guide. Please try to extend it accordingly while you implement new features.
💡 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
# Navigate back to `docs` folder cd ./docs/ # Run hugo server locally hugo server
And that’s it! Now you can open the browser with the URL
💡 You can specify -D option if you consider writing a draft.