https://github.com/michael-f-bryan/adventures.michaelfbryan.com

A simple blog for documenting my thoughts and adventures
https://github.com/michael-f-bryan/adventures.michaelfbryan.com

adventures blog rust

Last synced: 7 days ago
JSON representation

A simple blog for documenting my thoughts and adventures

• Host: GitHub
• URL: https://github.com/michael-f-bryan/adventures.michaelfbryan.com
• Owner: Michael-F-Bryan
• Created: 2019-09-01T12:02:30.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-14T01:45:07.000Z (7 months ago)
• Last Synced: 2024-04-14T01:49:17.966Z (7 months ago)
• Topics: adventures, blog, rust
• Language: HTML
• Homepage: http://adventures.michaelfbryan.com/
• Size: 45 MB
• Stars: 15
• Watchers: 3
• Forks: 3
• Open Issues: 20
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Michael's Adventures

(**[Published](http://adventures.michaelfbryan.com/)**)

A simple blog for documenting my thoughts and experiments.

## Getting Started

This blog uses the [Hugo][hugo] static site generator. You'll need to

[install it][install-hugo] before anything else.

During development you'll want to use the dev server to see changes the

moment they're made.

```console

hugo server --buildDrafts --buildExpired --buildFuture

```

This should start a HTTP server on http://localhost:1313/ that serves the site,

recompiling on every change.

## Custom Short-Codes and Templates

You can customise whether a page should receive the *"I've written a long

article but you don't need to read it all in one hit, here's a table of

contents"* message.

The logic goes something like this:

```python

def should_show_toc():

    if "toc" in frontMatter:

        return frontMatter["toc"]

    else:

        return page.readingTime > Site.Params.toc_reading_time_threshold

```

### Deployment

The real site is published to GitHub Pages on every commit to the `master`

branch.

This should all be handled by GitHub Actions automatically.

[install-hugo]: https://gohugo.io/getting-started/installing/

[hugo]: https://gohugo.io/