https://github.com/extrange/chanel

https://github.com/extrange/chanel

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/extrange/chanel
• Owner: extrange
• Created: 2022-04-03T03:21:12.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-09-15T01:40:50.000Z (3 months ago)
• Last Synced: 2024-09-15T07:48:48.161Z (3 months ago)
• Language: HTML
• Homepage:
• Size: 72.7 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Shared Website

Our personal website.

Structure:

-   Blog

-   Stories

-   Trips

It will not be indexed by Google due to the presence of [`noindex` as a meta tag][google-noindex].

A [Github workflow][github-workflow] is set to trigger on pushes to the `master` branch, which will build and deploy the site to [Github Pages][github-pages].

## Serving

_We have moved away from devcontainers, to speed up loading time._

Ensure that you have [uv] installed on your system.

Run `uv sync` to sync dependencies.

Then, simply open the repo, and serve the blog by running `mkdocs serve`. You may have to close/reopen your terminal for the virtual environment to be activated.

[github-pages]: https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages

[github-workflow]: https://docs.github.com/en/actions/using-workflows/triggering-a-workflow

[google-noindex]: https://developers.google.com/search/docs/advanced/crawling/block-indexing

[uv]: https://docs.astral.sh/uv/getting-started/installation/