Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonascript/htmlgoddess
A static site generator to code like its 1999
https://github.com/jonascript/htmlgoddess
cms-framework static-site static-site-generator
Last synced: about 1 month ago
JSON representation
A static site generator to code like its 1999
- Host: GitHub
- URL: https://github.com/jonascript/htmlgoddess
- Owner: jonascript
- Created: 2020-05-21T21:45:37.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T08:12:32.000Z (about 2 years ago)
- Last Synced: 2024-09-19T11:42:35.889Z (3 months ago)
- Topics: cms-framework, static-site, static-site-generator
- Language: TypeScript
- Homepage: https://findingmyhtmlgoddess.com
- Size: 4.97 MB
- Stars: 47
- Watchers: 2
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-starred - jonascript/htmlgoddess - A static site generator to code like its 1999 (others)
README
# htmlgoddess
A minimalist framework for creating a website like it's 1999.
## Requirements
- A computer with the internet, a text editor, and a web browser
- npm
## Getting Started
1. Open terminal
1. ``` npm install -g @htmlgoddess/cli ```
This will install the command line utility.
1. ``` htmlgoddess create path/to/your/new/site ```
1. follow the prompts and you should be up and running in no time.
## To Do
- refactor: isolate tests.
- add: "host" command.
- add: style choose command to allow the user to change theme after creation.
- feat: Spell checker.
- feat: auto commitizen hook to trigger when committing.
- feat: proofread commands.
- feat: "domain" command.
- feat: downloadable executable.
- refactor: Swap CNAME for yaml config for hosting.
- task: coverage
- convert "docs" to configurable variables
- task: make sure the watcher doesn't leak memory.
- bug: cli.action still outputting to console during tests.
- feat: GUI
# I don't know any HTML
That's ok. Check out [this video](https://www.youtube.com/watch?v=3RXlQPkJzCM) to get started.
## Command Line Menu
When you run ``` npm start ``` and it will give you the following options.
## How it works
- Files in the "src" folder are compiled (printed) to static HTML files in the "docs" folder.
- ``` src/templates ``` folder contains the templates. These are compiled with the content folder to generate your static HTML pages.
- ``` src/content ``` folder contains your site content, which is kept in html files that are chunks of HTML code.
- When you run ``` npm run print ``` (or select print from terminal menu), it will compile your content and templates into static HTML files and recreate the docs folder. (NOTE: Everything in docs gets overwritten so only save content in your src directory!)
- You can test your site locally by running the "serve" command from the menu.
- When you are ready to deploy your site, just do
``` npm run save && npm run publish```
- You can then point your web server to "docs" whether it be apache, git pages, nginx, or anything.
- You can add any stylesheet that targets plain HTML elements and it should work :)
## Templates
- Tags in the template that are self closing like `