🌐
Opensource.com
opensource.com › article › 20 › 7 › docsify-github-pages
How to create a documentation site with Docsify and GitHub Pages | Opensource.com
July 28, 2020 - In this tutorial, I'll show you one option for doing so: combining the Docsify documentation generator with GitHub Pages. If you prefer to learn by video, you can access the YouTube version of this how-to: By default, GitHub Pages prompts users to use Jekyll, a static site generator that supports HTML, CSS, and other web technologies. Jekyll generates a static website from documentation files encoded in Markdown format, which GitHub automatically recognizes due to their .md or .markdown extension.
🌐
GitHub
docs.github.com › en › pages
GitHub Pages documentation - GitHub Docs
You can create a GitHub Pages site in a new or existing repository. ... You can use Jekyll to create a GitHub Pages site in a new or existing repository.
Discussions

How to efficiently build a portfolio on Github?
I'm on a hiring panel and often look at github accounts for potential candidates. So to answer your question "add a repository" or "create a new project". Those are two different things. A repository is essentially your code, it's a place to store (and version) your code. In github speak, a project is how you track the work associated with your repo. But the repo is actual code itself, if that makes sense. Rather than simply using github as a way to upload source code, I would encourage you to learn git and specifically how to make regular commits as part of your workflow. Version control is a key tool for software developers and will provide you with a lot of value, even in school. If you're not too familiar with git, please see the free code school course on git https://www.codeschool.com/courses/try-git Things that I look for when looking at git repos: Is there a readme page that explains the purpose of the repo. This should also include documentation on how to run the code. Are there unit tests (or any tests) as part of the repo. How many commits are made on the repo? Github exposes all the git commit history. It's nice to be look at a project and see how it has grown over time. Rather than a single commit with "here's the code". I look at commit messages. Are they useful? Do they provide value and express the reason for the change or is something like "changed shit" (which is a horrible commit message btw). Groupings . A repo should represent a single project, and sometimes I see a single repo with just hundreds of random code files that are in no way related. Most importantly I pick a few random files and look at the code, is it following common standards. Does it follow conventions and styles? How easy is it to read? Are there comments? Are there too many comments? Basically looking for items from the book code complete (which is a great book btw). When it comes to code, some things to keep in mind: Don't have long blocks of commented out code. This is just a waste of space and adds visual bloat. If you're worried about losing that code, it won't be lost if you use git correctly and have several commits. you can always go back in git. Variable names. Are the names meaningful and express intent or is it something like "int something1; int something2" which provides me no context. Duplication. Is there a lot of duplication in the code? Could it be rewritten in a way to follow the DRY principle(don't repeat yourself.) Comments that state the obvious. for example //returns the count int getCount(){ return _counter; } That comment is useless because it's redundant. I hope this was helpful. Good luck! More on reddit.com
🌐 r/learnprogramming
68
686
January 17, 2018
Using github for technical documentation writing. How to do it?
I don’t mean to be blunt, but the scope of this question is too broad to provide you useful information (IMO). So my suggestion is: Do some self guided research on this topic Come back with more specific questions I think you’ll get more useful replies if you spend 0.5-1 day on step one. More on reddit.com
🌐 r/technicalwriting
8
4
March 14, 2023
🌐
Medium
wise4rmgodadmob.medium.com › how-to-create-a-documentation-site-with-docsify-and-github-pages-doc-as-a-code-c419c44e99b7
How to create a documentation site with Docsify and Github Pages (Doc as a code) | by Nwokocha Wisdom Maduabuchi | Medium
December 3, 2020 - In this article, you will learn about GitHub pages, Docsify, documentation, technical writing, Doc as code, and how to create technical documentation with Doctify and Github pages. There are so many docs as code tools/ templates but in this article i will use Docsify, below are the few static site generators for doc as code. Docsify: generates your documentation website on the fly. Unlike GitBook, it does not generate static Html to learn more about Docsify click here · Mkdocs: builds completely static HTML sites that you can host on GitHub pages, Amazon S3, or anywhere else you choose.
🌐
OpenReplay
blog.openreplay.com › openreplay blog › a complete guide to building a professional docs website from your github readme file
A Complete Guide to Building a Professional Docs Website from your GitHub README file
March 6, 2023 - Next, you must deploy the index.html file on GitHub Pages. Commit the changes to your repository and push them to the main branch. GitHub Pages will automatically build and deploy the documentation website.
🌐
GitHub
docs.github.com › en › pages › quickstart
Quickstart for GitHub Pages - GitHub Docs
Under "Build and deployment", under "Branch", use the branch dropdown menu and select a publishing source. Optionally, open the README.md file of your repository. The README.md file is where you will write the content for your site.
🌐
GitHub
docs.github.com › en › pages › getting-started-with-github-pages › creating-a-github-pages-site
Creating a GitHub Pages site - GitHub Docs
If you use a custom build process or a static site generator other than Jekyll, you can write a GitHub Actions workflow to build and publish your site. GitHub provides workflow templates for several static site generators.
🌐
Docascode
docascode.github.io › template › tutorial › getting-started
Getting Started
The easiest way to install docfx is to use .NET Tools. Install the latest version of .NET SDK and run: ... Or you can download from GitHub Releases. Open a command shell, and enter the following command: ... The preceding command creates a new documentation project. The -o mydocs parameter creates a directory named mydocs with the project files inside. ... After the command shell indicates that the website has started, browse to https://localhost:5001.
🌐
Medium
proandroiddev.com › how-to-create-a-documentation-website-for-your-project-with-github-actions-mkdocs-and-dokka-250c881e6f40
How to create a documentation website for your project with GitHub Actions, mkdocs, and Dokka
March 10, 2024 - The first line uses Nginx as a server for static websites. Second line we need to copy the site we built before into the nginx htmldirectory. This directory should have index.html an entry point. That's why we named our site dir as html , to make this step simpler. Let's add steps to the workflow required to build a Docker image and upload it to the GitHub Packages.
Find elsewhere
🌐
DEV Community
dev.to › michaelcurrin › how-to-build-a-docs-site-4h42
How to build a docs site - DEV Community
May 20, 2020 - You've got a Github repo with a docs folder, but it is disappointingly bland. How do you make it better? You can turn it into a docs site. But how do you make sure to... ... So some good solutions for building a docs site that meets these requirements are Jekyll, Docsify.js and MkDocs.
🌐
ITNEXT
itnext.io › create-compelling-documentation-with-github-pages-16e4149efe9e
Create compelling Documentation with Github Pages | by Thomas Reinecke | ITNEXT
September 6, 2022 - In this article, you will learn how to use Github pages as a new home for your project documentation. This document describes the GIT Playbook project hosted on GitHub.
🌐
GitHub
github.blog › home › developer skills › publish your project documentation with github pages
Publish Your Project Documentation with GitHub Pages - The GitHub Blog
June 24, 2021 - You might be familiar with how ... you build your first GitHub Pages site. Recent improvements to GitHub Pages have made it easier to publish your site from a variety of sources. One of these sources is your repository’s /docs folder. Quality documentation is a hallmark ...
🌐
GitHub
github.com › topics › documentation-website
documentation-website · GitHub Topics · GitHub
Reload to refresh your session. ... Retype is an ultra-high-performance static site generator that builds a website based on simple text files. Made in Canada 🇨🇦. cli documentation docs notes documentation-tool notebooks static-site-generation documentation-generator documentation-website ...
🌐
GitHub
github.com › topics › documentation-site
documentation-site · GitHub Topics
A simple, fast, free & easy to use static based plain HTML template. That allows you to make a beautiful personal / blog or technical documentation website really quickly.
🌐
GitHub
docs.github.com › en
GitHub.com Help Documentation
Get started, troubleshoot, and make the most of GitHub. Documentation for new users, developers, administrators, and all of GitHub's products.
🌐
Colin Hacks
colinhacks.com › essays › docs-the-smart-way
From README to documentation site in 10 minutes
May 12, 2022 - Authenticate with GitHub (or GitLab or Bitbucket) and select your repository. When prompted for a "Branch to deploy" select master (the default) unless your primary branch has a different name.
🌐
.NEXT
dotnet.github.io › docfx
Quick Start | docfx - Microsoft .NET - GitHub Pages
In this section we will build a simple documentation site on your local machine. ... Make sure you have .NET SDK installed, then open a terminal and enter the following command to install the latest docfx: ... This command walks you through creating a new docfx project under the current working directory. To build the docset, run: ... Now you can preview the website on http://localhost:8080.
🌐
JetBrains
jetbrains.com › help › writerside › deploy-docs-to-github-pages.html
Build and publish on GitHub | Writerside Documentation
March 6, 2025 - The build job runs on the latest Ubuntu virtual machine and consists of three steps: Checkout the project repository using the actions/checkout@v4 action. Generate the documentation website using the JetBrains/writerside-github-action@v4 action.
🌐
Docsify
docsify.js.org
docsify
Unlike most other documentation site generator tools, it doesn't need to build HTML files. Instead, it dynamically loads and parses your Markdown files and displays them as a website. To get started, create an index.html file and deploy it on GitHub Pages (for more details see the Quick start ...
🌐
GitHub
github.com › mkdocs › mkdocs
GitHub - mkdocs/mkdocs: Project documentation with Markdown. · GitHub
It is designed to be easy to use and can be extended with third-party themes, plugins, and Markdown extensions. Please see the Documentation for an introductory tutorial and a full user guide. Build static HTML files from Markdown files.
Author: mkdocs