A simple static blog website to record what I read (mainly for the 2 pages a day challenge).
- 📝 Write blog posts in Markdown
- 📁 Organize posts by sections (folders)
- 🌙 Dark mode and ☀️ Light mode with toggle
- 📱 Responsive design
- ✨ Clean, minimal list-based styling
- 🗂️ Collapsible sections for better organization
- 🤖 Automatic markdown file discovery
-
Create a markdown file in one of the blog section folders:
blog/books/- For book reviews and notesblog/articles/- For article summariesblog/daily-reads/- For daily reading logs
-
Write your post in Markdown format. Start with a title:
# Your Post Title date: 2024-01-15 Your content here... -
Generate the blog manifest to automatically discover your new post:
node generate-manifest.js # Or using npm: npm run update-manifestThis will scan all markdown files in the
blog/directory and update theblog-manifest.jsonfile. -
Commit and push your changes to GitHub
To add a new blog section:
- Create a new folder in the
blog/directory - Add your markdown files to the new folder
- Run
node generate-manifest.jsto update the manifest - Your new section will automatically appear on the site!
The site supports both dark and light modes:
- Click the 🌙/☀️ button in the header to switch themes
- Your preference is saved in browser localStorage
- Theme persists across page navigation
Simply open index.html in your web browser. For the best experience, use a local web server:
# Using Python 3
python -m http.server 8000
# Using Node.js
npx http-serverThen open http://localhost:8000 in your browser.
This site is designed to work with GitHub Pages. Enable it in your repository settings:
- Go to Settings → Pages
- Select the branch (e.g.,
main) and root folder - Your site will be available at
https://yourusername.github.io/apramreads/
MIT