|
| 1 | +# Instant History Blog |
| 2 | + |
| 3 | +This is Michael Morisy's personal blog built with Jekyll and hosted on GitHub Pages. |
| 4 | + |
| 5 | +## Quick Start |
| 6 | + |
| 7 | +### Writing a New Post |
| 8 | + |
| 9 | +1. Create a new file in the `_posts` folder |
| 10 | +2. Name it using the format: `YYYY-MM-DD-post-title.md` |
| 11 | +3. Add the following front matter at the top: |
| 12 | + |
| 13 | +```yaml |
| 14 | +--- |
| 15 | +layout: post |
| 16 | +title: "Your Post Title" |
| 17 | +subtitle: "Optional subtitle" |
| 18 | +date: 2024-01-15 10:00:00 |
| 19 | +tags: [tag1, tag2] |
| 20 | +--- |
| 21 | +``` |
| 22 | + |
| 23 | +4. Write your content using Markdown |
| 24 | + |
| 25 | +### Markdown Features |
| 26 | + |
| 27 | +This blog supports enhanced markdown features: |
| 28 | + |
| 29 | +- **GitHub Flavored Markdown**: Tables, strikethrough, task lists |
| 30 | +- **Code syntax highlighting**: Use triple backticks with language identifier |
| 31 | +- **Emojis**: Type `:emoji_name:` (e.g., `:smile:`) |
| 32 | +- **@mentions**: Link to GitHub users with `@username` |
| 33 | +- **Footnotes**: Use `[^1]` for footnote markers |
| 34 | + |
| 35 | +Example: |
| 36 | +```markdown |
| 37 | +This is some text with a footnote[^1]. |
| 38 | + |
| 39 | +[^1]: This is the footnote content. |
| 40 | +``` |
| 41 | + |
| 42 | +### Local Development |
| 43 | + |
| 44 | +1. Install Ruby and Bundler |
| 45 | +2. Run `bundle install` to install dependencies |
| 46 | +3. Run `bundle exec jekyll serve` to start local server |
| 47 | +4. Visit `http://localhost:4000` |
| 48 | + |
| 49 | +### Deployment |
| 50 | + |
| 51 | +The site automatically deploys to GitHub Pages when you push to the main branch. |
| 52 | + |
| 53 | +## Features |
| 54 | + |
| 55 | +- **SEO Optimization**: Automatic meta tags and Open Graph data |
| 56 | +- **Reading Time**: Shows estimated reading time for each post |
| 57 | +- **Sitemap**: Automatically generated at `/sitemap.xml` |
| 58 | +- **RSS Feed**: Available at `/feed.xml` |
| 59 | +- **Syntax Highlighting**: Beautiful code blocks with line numbers |
| 60 | +- **Social Sharing**: Twitter and Facebook share buttons |
| 61 | +- **Comments**: Configured for Staticman (requires setup) |
| 62 | + |
| 63 | +## Configuration |
| 64 | + |
| 65 | +Main settings are in `_config.yml`: |
| 66 | +- Site title and description |
| 67 | +- Author information |
| 68 | +- Social media links |
| 69 | +- Google Analytics |
| 70 | +- Comment system settings |
| 71 | + |
| 72 | +## Tips |
| 73 | + |
| 74 | +- Use `<!--more-->` in posts to set excerpt break point |
| 75 | +- Add `image: /path/to/image.jpg` in front matter for social media previews |
| 76 | +- Use `redirect_from: /old-url/` to redirect old URLs |
| 77 | +- Posts with future dates won't be published until that date |
| 78 | + |
| 79 | +## Troubleshooting |
| 80 | + |
| 81 | +If the site doesn't update after pushing: |
| 82 | +1. Check GitHub Actions tab for build errors |
| 83 | +2. Ensure post filenames are correctly formatted |
| 84 | +3. Verify front matter YAML is valid |
| 85 | +4. Check that post dates aren't in the future |
0 commit comments