Skip to content

apramm/apramreads

Repository files navigation

Apram Reads

A simple static blog website to record what I read (mainly for the 2 pages a day challenge).

Features

  • 📝 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

How to Add a New Blog Post

  1. Create a markdown file in one of the blog section folders:

    • blog/books/ - For book reviews and notes
    • blog/articles/ - For article summaries
    • blog/daily-reads/ - For daily reading logs
  2. Write your post in Markdown format. Start with a title:

    # Your Post Title
    
    date: 2024-01-15
    
    Your content here...
  3. Generate the blog manifest to automatically discover your new post:

    node generate-manifest.js
    # Or using npm:
    npm run update-manifest

    This will scan all markdown files in the blog/ directory and update the blog-manifest.json file.

  4. Commit and push your changes to GitHub

Creating a New Section

To add a new blog section:

  1. Create a new folder in the blog/ directory
  2. Add your markdown files to the new folder
  3. Run node generate-manifest.js to update the manifest
  4. Your new section will automatically appear on the site!

Theme Toggle

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

Local Development

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-server

Then open http://localhost:8000 in your browser.

GitHub Pages

This site is designed to work with GitHub Pages. Enable it in your repository settings:

  1. Go to Settings → Pages
  2. Select the branch (e.g., main) and root folder
  3. Your site will be available at https://yourusername.github.io/apramreads/

License

MIT

About

some sort of blog website to just record what i read today (mainly for the 2 pages a day challenge)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors