Norm

owner0220.github.io

Wikidocs-style static project reader for GitHub Pages.

Commands

npm install
npm audit --audit-level=low
npm run build
npm run dev

Projects live under content/books/<project-slug>/.

Each project has:

• book.json for title, author, description, cover, and tags
• SUMMARY.md for the table of contents
• Markdown pages referenced by SUMMARY.md
• optional assets/ files for project images

The generated site is written to dist/.

Project cards link directly to the reader. The first Markdown page is generated as books/<project-slug>/, and later pages use numbered HTML files such as books/<project-slug>/2.html.

Editor

Run npm run dev and open /editor.html to create or update one project at a time. The editor is local-only and is not included in the GitHub Pages build.

Use the local save button to write generated files directly under content/books/<project-slug>/. The dev server rebuilds dist/ after saving so the project list and reader update immediately.

The expected output tree is:

content/books/<project-slug>/
  book.json
  SUMMARY.md
  pages/
    introduction.md
  assets/
    cover.png

GitHub Pages only serves the project list and reader pages. It does not expose the editor or any write API.

Security and GitHub Pages

The deploy workflow runs npm audit --audit-level=low before building. Fix any reported dependency issue before deploying.

For GitHub Pages, check these repository settings when Actions fail even though the local build passes:

• Set the repository default branch to main.
• Set Pages source to GitHub Actions.
• Disable or clean up older Pages/Jekyll branches if they still trigger dependency alerts or deployments.