Skip to content

jc-cr/jc-cr.github.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

189 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JC's Website

My website. For free thanks to the generosity of Github. In return I offer you my data.

Post Generation

Posts are generated using a combination of Markdown files and a custom static site generator that converts them to HTML.

Creating New Posts

  1. Run the post GUI with Docker Compose:
docker compose up post_gui --remove-orphans --abort-on-container-exit
  1. Select a Markdown file, enter title and date, and select appropriate tags
  2. Click "Create Post" to generate the HTML and update the indices

Each post is stored in /webpage/posts/YYYYMMDD_title with:

  • post.html - The generated HTML content
  • meta.json - Metadata including title, date, tags, and snippet
  • Any media files (images, videos) referenced in the post

Manually Updating Indices

If you need to regenerate all index files without creating a new post:

docker compose run --rm update_index

This will scan all posts and generate index files for all tags and an index of all posts.

Adding an App

A repository with just vanilla HTML, CSS, and JavaScript can be added to the apps dir as a submodule. Just make sure the workflow includes submodules like:

      - name: Checkout
        uses: actions/checkout@v4
        with:
          submodules: true

Environment Setup

Create a .env file in the .docker directory with:

OBSIDIAN_PATH=/path/to/your/obsidian/vault

This tells the container where to find your Markdown files.

Viewing the Site Locally

The site can be viewed locally by running:

docker compose up view_page --remove-orphans --abort-on-container-exit

Then navigate to http://localhost:8080.

About

Website

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published