|
8 | 8 | </h3> |
9 | 9 |
|
10 | 10 | ## Features |
11 | | -* Light & dark mode with theme switcher |
| 11 | +* Light & dark mode with theme switcher (respects `prefers-reduced-motion`) |
12 | 12 | * Vertical list, horizontal list, card list |
13 | 13 | * Landing page with navbar, footer, portfolio |
14 | 14 | * Fast (very minimal CSS) - 100/100 on performance, accessibility, best practices and SEO, please see [Lighthouse Report](https://raw.githubusercontent.com/abhinavs/moonwalk/master/_screenshots/lighthouse-report.png) for more details |
15 | 15 | * Responsive and mobile friendly |
16 | | -* SEO optimized (uses [Jekyll Soopr SEO Tag](https://github.com/jekyll/jekyll-soopr-seo-tag)) |
| 16 | +* SEO optimized with auto-generated sitemap |
17 | 17 | * RSS feed (uses [Jekyll Feed](https://github.com/jekyll/jekyll-feed)) |
| 18 | +* [GitHub Markdown Alerts](#github-markdown-alerts) (NOTE, TIP, IMPORTANT, WARNING, CAUTION) |
| 19 | +* Tag archive page with clickable tags |
| 20 | +* Light and dark mode syntax highlighting |
| 21 | +* Accessible - skip-to-content link, ARIA labels, keyboard friendly |
18 | 22 | * Easy to extend |
19 | 23 | * Fully compatible with [GitHub Pages](https://pages.github.com/) (see [GitHub Pages installation](#github-pages-installation)) |
20 | 24 | * Auto-generated share images for social media (using [Soopr](https://www.soopr.co)) |
@@ -118,17 +122,40 @@ html { |
118 | 122 |
|
119 | 123 | <img src="https://raw.githubusercontent.com/abhinavs/moonwalk/master/_screenshots/twitter_card.png" /> |
120 | 124 |
|
| 125 | +### GitHub Markdown Alerts |
| 126 | + |
| 127 | +Moonwalk supports [GitHub-style Markdown Alerts](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts). Use them in your posts like this: |
| 128 | + |
| 129 | +```markdown |
| 130 | +> [!NOTE] |
| 131 | +> Useful information that users should know, even when skimming content. |
| 132 | +
|
| 133 | +> [!TIP] |
| 134 | +> Helpful advice for doing things better or more easily. |
| 135 | +
|
| 136 | +> [!IMPORTANT] |
| 137 | +> Key information users need to know to achieve their goal. |
| 138 | +
|
| 139 | +> [!WARNING] |
| 140 | +> Urgent info that needs immediate user attention to avoid problems. |
| 141 | +
|
| 142 | +> [!CAUTION] |
| 143 | +> Advises about risks or negative outcomes of certain actions. |
| 144 | +``` |
| 145 | + |
| 146 | +All five alert types are styled with color-coded left borders and icons, and work in both light and dark mode. |
| 147 | + |
121 | 148 | ## Contributing |
122 | 149 |
|
123 | | -Bug reports and pull requests are welcome on GitHub at https://github.com/abhinavs/moonwalk. |
| 150 | +Please see [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines. |
124 | 151 |
|
125 | 152 | ## Development |
126 | 153 |
|
127 | | -To set up your environment to develop this theme, run `bundle install`. |
128 | | - |
129 | | -Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal. |
| 154 | +1. Run `bin/bootstrap` (or `make setup`) to install dependencies |
| 155 | +2. Run `bin/start` (or `make serve`) to start the dev server with live reload at `http://127.0.0.1:4000` |
| 156 | +3. Run `bin/build` (or `make build`) for a production build |
130 | 157 |
|
131 | | -When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled. |
| 158 | +When your theme is released, only the files in `_layouts`, `_includes`, `_sass`, `_data`, and `assets` tracked with Git will be bundled. |
132 | 159 | To add a custom directory to your theme-gem, please edit the regexp in `moonwalk.gemspec` accordingly. |
133 | 160 |
|
134 | 161 | ## Acknowledgement |
|
0 commit comments