emacs-ssg
This site is created using the emacs-ssg static site generator, which
turns text files, into HTML web pages, ready to be published or
customized. Opening emacs is not required, it is used in the
background to generate the site's pages.
- manual(s) for documentation
- examples to showcase possible usages
- npm package to use in the node.js ecosystem
- git repository for this project's code
- matrix chat for community assistance
Getting started
To print the installation instructions and getting started guide, use the following command:
npm create @sctlib/emacs-ssg
> @sctlib/emacs-ssg@0.0.16 npx > create-emacs-ssg
→ dependencies: "emacs" and "inotifywait", the dependencies
→ create a new folder 'my-site', and navigate into it
→ (optional) make the project's folder a git repository (easier to publish)
git init
→ Install @sclib/emacs-ssg
npm install --save-dev @sctlib/emacs-ssg
→ inside the 'package.json.scripts' add 3 scripts and the key "@sctlib/emacs-ssg": {} with and empty config object
{
"scripts": {
"dev": "emacs-ssg watch",
"build": "emacs-ssg build",
"publish-pages": "emacs-ssg publish-pages"
},
"@sctlib/emacs-ssg": {}
}
→ Run the local development server
npm run dev
It will watch the project folder for changes, and rebuild
→ Create the content/assets folders and files
./content/index.org (text content, org-mode optional)
./assets/css/index.css (css content)
./assets/js/index.js (javascript content)
→ To build a website for publishing, into ./public (no minification)
mpm run build
→ For CI/CD, "to update emacs packages" and build, use
npm run publish-pages
The output of the "create" command only display the instructions to follow.