✨feature: First working version with dummy content
Some checks failed
build-site / build (push) Failing after 6m4s
Some checks failed
build-site / build (push) Failing after 6m4s
This commit is contained in:
19
README.md
19
README.md
@@ -1,3 +1,20 @@
|
||||
# Dev Notes
|
||||
|
||||
My Collection of notes, ponderings, and documentation for various dev projects.
|
||||
Lightweight static notes site built from Markdown with front matter. A small Node-based generator produces HTML ready for Cloudflare Pages.
|
||||
|
||||
## Quick start
|
||||
|
||||
- Install Node 20+: `npm install`
|
||||
- Build the site: `npm run build`
|
||||
- Open `dist/index.html` in a browser or serve via `npx serve dist`
|
||||
|
||||
## Content structure
|
||||
|
||||
- Write notes in `content/` using kebab-case filenames and front matter (`title`, `section`, `summary`, `tags`, optional `nav`).
|
||||
- Sections map to directories in the output (`/section-slug/`), and each note becomes `/section-slug/note-slug/`.
|
||||
- Templates live in `templates/`; shared styles and scripts live in `assets/`.
|
||||
|
||||
## Deployment
|
||||
|
||||
- The GitHub action `.github/workflows/build.yml` installs dependencies and runs the build.
|
||||
- Cloudflare Pages can publish the `dist/` directory produced by `npm run build`.
|
||||
|
||||
Reference in New Issue
Block a user