forked from trimstray/the-book-of-secret-knowledge
-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgithub-pages
Milestone
Description
Goal
Establish the source folder for GitHub Pages so we can enable the site without disrupting the root README or existing content.
Tasks
-
Create empty docs/ folder at repo root.
-
Copy current README.md → docs/index.md (this becomes the home page).
- Keep all existing content (Quick Access table, mission statement, directory overview).
- Add a temporary banner at the top (as markdown comment or front-matter note):
-
Create docs/Gemfile with minimal content:
source "https://rubygems.org"
gem "jekyll", "~> 4.3"
gem "just-the-docs", "~> 0.8" # or whichever theme we settle on- Create docs/_config.yml starter (minimal Just the Docs theme – we can refine later):
title: The Book of Secret Knowledge (JK Revisions)
description: Curated collection of infosec, sysadmin, networking, privacy, and tooling knowledge
remote_theme: just-the-docs/just-the-docs
# Basic navigation (expand in Phase 2)
aux_links:
"GitHub Repo": https://github.com/jacob-kraniak/the-book-of-secret-knowledge/tree/JK_Revisions
# Optional: color_scheme: dark (test later)- Commit message suggestion: "feat(pages): initial /docs/ setup with index.md and minimal Jekyll config"
Acceptance Criteria
- docs/ folder exists with at least index.md, Gemfile, _config.yml.
- No syntax errors in the new files (test locally with bundle exec jekyll build if possible).
- Ready to enable Pages in repo settings → Branch: JK_Revisions, Folder: /docs.
Notes
- Theme choice: Starting with just-the-docs (clean sidebar TOC, search, mobile-friendly, zero plugins needed on GH Pages).
- If you prefer Chirpy or Minimal Mistakes, swap the remote_theme line and adjust Gemfile accordingly.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgithub-pages