✨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:
37
content/docs-markdown-authoring.md
Normal file
37
content/docs-markdown-authoring.md
Normal file
@@ -0,0 +1,37 @@
|
||||
---
|
||||
title: Markdown Authoring Guide
|
||||
section: docs
|
||||
summary: Conventions for writing notes, front matter fields, and embedding code or media in the site.
|
||||
tags: [markdown, style, notes]
|
||||
nav: 1
|
||||
---
|
||||
|
||||
# Markdown Authoring Guide
|
||||
|
||||
## Front matter
|
||||
Provide metadata at the top of every note:
|
||||
|
||||
```
|
||||
---
|
||||
title: Example Title
|
||||
section: docs
|
||||
summary: One-sentence overview for listings.
|
||||
tags: [topic, keyword]
|
||||
nav: 1
|
||||
---
|
||||
```
|
||||
|
||||
- `section`: logical bucket (docs, infra, backend, frontend, etc.).
|
||||
- `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.
|
||||
26
content/infra-workflow.md
Normal file
26
content/infra-workflow.md
Normal file
@@ -0,0 +1,26 @@
|
||||
---
|
||||
title: Cloudflare Pages Workflow
|
||||
section: infra
|
||||
summary: Steps to publish the static notes site to Cloudflare Pages using the provided workflow and build output.
|
||||
tags: [cloudflare, ci, deploy]
|
||||
nav: 1
|
||||
---
|
||||
|
||||
# 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.
|
||||
|
||||
## Build steps
|
||||
1. Install dependencies: `npm install`.
|
||||
2. Generate the site: `npm run build`.
|
||||
3. Upload the `dist/` output to Cloudflare Pages.
|
||||
|
||||
## Environment
|
||||
- Node 20+ is recommended.
|
||||
- CI uses `npm ci` and `npm run build` from the default branch.
|
||||
|
||||
## Tips
|
||||
- Keep content in `content/` with front matter to expose metadata.
|
||||
- The build bundles a `search-index.json`; avoid storing secrets in front matter.
|
||||
- Regenerate locally before pushing to preview changes.
|
||||
24
content/ops-onboarding.md
Normal file
24
content/ops-onboarding.md
Normal file
@@ -0,0 +1,24 @@
|
||||
---
|
||||
title: Developer Onboarding
|
||||
section: ops
|
||||
summary: Quick start steps to clone, install dependencies, and generate the site locally.
|
||||
tags: [onboarding, setup]
|
||||
nav: 1
|
||||
---
|
||||
|
||||
# Developer Onboarding
|
||||
|
||||
1. Clone the repository and install Node 20+.
|
||||
2. Run `npm install` to pull dependencies.
|
||||
3. Build with `npm run build`; output lands in `dist/`.
|
||||
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.
|
||||
- Keep summaries short; they populate listings and the search index.
|
||||
- Add tags to improve search results.
|
||||
Reference in New Issue
Block a user