Auto-build and host pretty HTML documentation using AsciiDoc, GitHub Pages & GitHubActions

Auto-build and host pretty HTML documentation using AsciiDoc, GitHub Pages & GitHubActions

Auto-build and host pretty HTML documentation using AsciiDoc, GitHub Pages & GitHub Actions. How to automatically build AsciiDoc into HTML on every Git commit using GitHub actions, and host it using GitHub pages. I use AsciiDoc for the “real” documentation.

How to automatically build AsciiDoc into HTML on every Git commit using GitHub actions, and host it using** GitHub pages.**

Example of the end result;

Setup AsciiDoc in your repository

GitHub favours Markdown the the README — so in my projects I keep a README.md that describes the project like normal. , but I use AsciiDoc for the “real” documentation. My real documentation spans multiple files, so I use a docs directory in my repositories. As your project grows, you’ll find you cannot document everything in the README.md .

While your README.md serves as a high level introduction, or a quickstart to your project, your docs is something different — much more detailed, how to use your project, troubleshooting etc. I use AsciiDoc because I’ve found it’s better than markdown for more detailed project documentation.

If you’re not used AsciiDoc before, it’s similar to Markdown, but has lots of extra syntax that allows for much more rich documentation. For example, tables of contents, better control over heading levels, links to headings, heading numbering, etc.

github github-pages documentation

Bootstrap 5 Complete Course with Examples

Bootstrap 5 Tutorial - Bootstrap 5 Crash Course for Beginners

Nest.JS Tutorial for Beginners

Hello Vue 3: A First Look at Vue 3 and the Composition API

Building a simple Applications with Vue 3

Deno Crash Course: Explore Deno and Create a full REST API with Deno

How to Build a Real-time Chat App with Deno and WebSockets

Convert HTML to Markdown Online

HTML entity encoder decoder Online

A Simple Guide to Github Page Deployment

Long story short: Jekyll is a template engine changing markdown documents on static HTML webpages, that you can then host anywyere, because you don't need databases or server that has PHP or Python.

Deploying my portfolio website on Github Pages using Github Actions.

Deploying my portfolio website on Github Pages using Github Actions. I recently deployed my portfolio site and wanted to try out github actions and this is my experience of automating the deployment.

How to Publish a Book with GitBook CLI and GitHub Pages in 7 Minutes

In this post, I will show you how to publish your book or documentation on GitHub Pages in less than ten minutes.

How to Compare Multiple GitHub Projects with Our GitHub Stats tool

In this article we are going to compare three most popular machine learning projects for you.

Convert Your Jupyter-notebook to Github pages with Github-action

Convert Your Jupyter-notebook to Github pages with Github-action. Merge pull request and wait until Github-action makes Github pages.