Docsify Open Publishing Starter Kit

This is a starter kit to create an open Docsify publishing site. Global navigation elements can be hidden for seamlessly embedding pages into other platforms. Includes a pre-configured "Edit this Page on GitHub" link.

📸 Docsify Open Publishing Screenshot

Figure 1. Docsify Open Publishing Starter Kit. Explore a demo at hibbitts-design.github.io/docsify-open-publishing-starter-kit/

🚀 GitHub Pages Quickstart

Pre-flight Checklist

1. GitHub account

Installation and Deployment

1. Tap Use this template on the source repository (upper-right green button)
2. Choose the name for your new repository to contain the copied site files and then tap Create repository from template
3. Go to Settings of your newly created repository, tap the Pages tab (on the left-hand side), choose main branch/docs folder and finally tap the Save button (see more details in the Docsify documentation)
4. Now your pages are published (view your new site using the provided URL on the Pages tab - it can take up to 20 minutes for your site to be initially available)

Configure the "Edit this Page on GitHub" Link

1. Go to the file index.html in the docs folder of your repository
2. Tap the Pencil Icon (top left-hand toolbar area) to start the editor
3. Find the original GitHub repository URL https://github.com/hibbitts-design/docsify-open-publishing-starter-kit and replace it with your own repository URL, for example https://github.com/your-github-username/your-repository-name
4. Scroll down to the bottom of the page and tap the Commit changes button to save your changes

💻 Locally Editing your Docsify Site Pages

Editing Your Docsify Site Pages on Your Desktop

1. Tap Clone on your repository page
2. Choose Open Desktop and follow the prompts, installing GitHub Desktop if not already present
3. You will now be able to edit your Docsify site (in the docs folder) using the desktop editor of your choice (e.g. atom.io)
4. Use GitHub Desktop to push any changes to your repository. Learn more about using GitHub Desktop.

You can also clone (i.e download) a copy of your repository to your computer and run Docsify locally to preview your site. See the below video for details.

Do you use GitLab? You can also use Docsify with GitLab Pages!

🧩 Embedding Docsify Page Content into Other Systems

The optional ‘embedded’ (all lowercase) URL parameter hides a site’s sidebar and optional navbar for seamlessly embedding Docsify page content within another platform such as Canvas LMS, Moodle, Microsoft Teams etc.

To only display Docsify page content, add the following to a Docsify page URL:

?embedded=true

For example, https://hibbitts-design.github.io/docsify-open-publishing-starter-kit/#/ would display a standard Docsify page while https://hibbitts-design.github.io/docsify-open-publishing-starter-kit/#/?embedded=true would only display page content (i.e. no sidebar or optional navbar is shown).

To optionally hide the 'Edit this Page on GitHub' link, use the following:

?embedded=true&hidegithublink=true

For example, https://hibbitts-design.github.io/docsify-open-publishing-starter-kit/#/ would display a standard Docsify page while https://hibbitts-design.github.io/docsify-open-publishing-starter-kit/#/?embedded=true&hidegithublink=true would only display page content (i.e. no sidebar or optional navbar is shown) and also hide the 'Edit this Page on GitHub' link.

📼 Video Walkthrough of Local Docsify Install/Config

Video 1. Generating Documentation Sites with GitHub and Docsify - Alysson Alvaran

📚 Learn More about Docsify

Docsify Documentation
Docsify Basics by MichaelCurrin

🙇‍Credits and Special Thanks

Docsify Themeable