GitHub – MaxGripe/skunk-html

Automatically generate a GitHub Pages website using Markdown files as source!

Markdown in, GitHub Pages out!

Your own Markdown blog on GitHub in less than 60 seconds:

1. fork SkunkHTML repository on GitHub.
2. Enable GitHub Pages in the repository settings (select GitHub Actions as source).
3. Done! Your blog is online! For example: https://max.gripe/skunk-html/

Upload Markdown (.md) files to publish new posts.

When a Markdown (.md) file is created and placed in the /markdown-blog/ folder, some happen automatically. GitHub Actions detect changes pushed to the repository, trigger the build process, and deploy the updated site.

• Blog articles and other content are written in Markdown, which allows for easy content creation and management. These Markdown files are automatically converted to HTML during the build process using F# and the FSharp.Formatting library.

• The deployment process is fully automated GitHub Actions. Any changes to this repository will be reflected on the live site immediately.

• Giscus Comment system is supported.

• The repository is 100% ready to work directly on GitHub without the need to download it locally. Just fork it to make your own website. Don’t forget to enable GitHub Pages in the repo! (Settings ➔ Pages ➔ Build and deploy: “GitHub Actions”).

• /: Project root directory.

  • .github/workflows/: GitHub Actions workflow file. Responsible for automatically creating a final website on GitHub Pages
  • assets/: Files used throughout the site, such as avatars, favicons, and other shared resources.
  • css/: CSS file for the site.
  • fonts/: Custom fonts go here.
  • html/: Fragments of HTML used throughout the site, such as the title and footer.
  • markdown-blog/: Directory containing Markdown files for articles and other content. Blog articles are identified by file names that begin with a single digit.
    • images/: Images used in articles.
  • scripts/: Syntax highlighting script and optional other custom scripts..
  • skunk-html-output/: Directory to be created during the build process, with the generated HTML files.

• LICENSE: License file for the project.

• Program.fs: F# program that handles the generation of HTML from Markdown

• README.md: This file.

• skunk-html.fsproj: Project file

Detailed examples can be found at: https://max.gripe/skunk-html

Feel free to post on discussions section for suggestions, open a ISSUES to report problems, or submit a pull request if you want to contribute to site improvements. Your input is always welcome!

This project is licensed under the terms of Not a license.

It also uses several external objects, each with its own license:

Although GitHub builds and hosts this site very well, if you want, you can build your blog locally, for example hosting it yourself. To do this:

1. Downloads and install .NET on Linux / macOS / Windows
2. Run the following commands

git clone https://github.com/MaxGripe/skunk-html.git
cd skunk-html
dotnet restore
dotnet run

3. It’s over. Your site is on skunk-html-output folder.