✨feature: Reorganize notes, and add section descriptions
This commit is contained in:
@@ -1,13 +1,11 @@
|
||||
---
|
||||
title: Cloudflare Pages Workflow
|
||||
section: infra
|
||||
summary: Steps to publish the static notes site to Cloudflare Pages using the provided workflow and build output.
|
||||
section: dev-notes
|
||||
summary: Steps to publish the static notes site to Cloudflare Pages using the provided workflow and build output
|
||||
tags: [cloudflare, ci, deploy]
|
||||
nav: 1
|
||||
nav: 3
|
||||
---
|
||||
|
||||
# Cloudflare Pages Workflow
|
||||
|
||||
## Overview
|
||||
|
||||
This note captures the build and deploy flow for the static notes site. The site compiles Markdown into static HTML under the `dist/` directory.
|
||||
@@ -1,17 +1,16 @@
|
||||
---
|
||||
title: Markdown Authoring Guide
|
||||
section: docs
|
||||
summary: Conventions for writing notes, front matter fields, and embedding code or media in the site.
|
||||
section: dev-notes
|
||||
summary: Conventions for writing notes, front matter fields, and embedding code or media in the site
|
||||
tags: [markdown, style, notes]
|
||||
nav: 1
|
||||
nav: 2
|
||||
---
|
||||
|
||||
# Markdown Authoring Guide
|
||||
|
||||
## Front matter
|
||||
|
||||
Provide metadata at the top of every note:
|
||||
|
||||
```
|
||||
```markdown
|
||||
---
|
||||
title: Example Title
|
||||
section: docs
|
||||
@@ -25,13 +24,15 @@ nav: 1
|
||||
- `nav`: optional integer to influence ordering within a section; lower numbers show first.
|
||||
|
||||
## Writing tips
|
||||
- Start with an `#` heading matching the title.
|
||||
|
||||
- Keep paragraphs short; use bullet lists for tasks.
|
||||
- Use fenced code blocks with language hints (` ```bash `, ` ```js `) for highlighting.
|
||||
- Link to related notes with absolute paths, e.g., `/docs/markdown-authoring-guide/`.
|
||||
|
||||
## Media
|
||||
|
||||
Place images next to the note or in an `/assets/media` folder and reference relatively.
|
||||
|
||||
## Testing locally
|
||||
|
||||
Run `npm run build` to regenerate HTML. Open `dist/index.html` in a browser to review layout and syntax highlighting.
|
||||
@@ -1,12 +1,12 @@
|
||||
---
|
||||
title: Developer Onboarding
|
||||
section: ops
|
||||
summary: Quick start steps to clone, install dependencies, and generate the site locally.
|
||||
section: dev-notes
|
||||
summary: Quick start steps to clone, install dependencies, and generate the site locally
|
||||
tags: [onboarding, setup]
|
||||
nav: 1
|
||||
---
|
||||
|
||||
# Developer Onboarding
|
||||
## Getting started
|
||||
|
||||
1. Clone the repository and install Node 20+.
|
||||
2. Run `npm install` to pull dependencies.
|
||||
@@ -14,11 +14,14 @@ nav: 1
|
||||
4. Serve `dist/` via any static server (e.g., `npx serve dist`).
|
||||
|
||||
## Directory overview
|
||||
|
||||
- `content/`: Markdown notes with front matter.
|
||||
- `templates/`: HTML shells for header, footer, and layout.
|
||||
- `assets/`: CSS and JavaScript shared across pages.
|
||||
|
||||
## Conventions
|
||||
|
||||
- Use kebab-case filenames.
|
||||
- For organization, use sections defined in `sections.json` and include section in filename.
|
||||
- Keep summaries short; they populate listings and the search index.
|
||||
- Add tags to improve search results.
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Gateway Documentation
|
||||
section: docs
|
||||
summary: Homelab Gateway — Traefik Reverse Proxy, Authelia SSO, LAN Routing, macvlan IP assignment, and Docker-managed services.
|
||||
summary: Homelab Gateway — Traefik Reverse Proxy, Authelia SSO, LAN Routing, macvlan IP assignment, and Docker-managed services
|
||||
tags: [networking, traefik, authelia, infrastructure, docker, home-lab]
|
||||
nav: 2
|
||||
---
|
||||
@@ -3,7 +3,7 @@ title: SoloForge Documentation
|
||||
section: docs
|
||||
summary: SoloForge Infrastructure Documentation for Self-Hosted Gitea with Actions Runner on Hetzner
|
||||
tags: [servers, infrasctructure, gitea, ci/cd, hetzner, docker]
|
||||
nav: 1
|
||||
nav: 2
|
||||
---
|
||||
|
||||
## Self-Hosted Gitea + Actions Runner (Hetzner Deployment)
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: My Servers
|
||||
section: network
|
||||
summary: My Servers.
|
||||
section: infra
|
||||
summary: Documentation relating to the various servers I use and maintain
|
||||
tags: [hardware, servers, infrasctructure]
|
||||
nav: 1
|
||||
---
|
||||
Reference in New Issue
Block a user