# cs-study-wiki **Repository Path**: libai4hao/cs-study-wiki ## Basic Information - **Project Name**: cs-study-wiki - **Description**: libai4hao cs study wiki! - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2021-11-06 - **Last Updated**: 2021-11-06 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Docsify Open Publishing Starter Kit [![Docsify](https://img.shields.io/npm/v/docsify?label=docsify)](https://docsify.js.org/) [![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/hibbitts-design/docsify-open-publishing-starter-kit/blob/main/LICENSE) Docsify Discord Chat > This is a starter kit to quickly create a Markdown-based open publishing site with the site generator [Docsify](https://docsify.js.org). Global navigation elements can be hidden for seamlessly embedding pages into other platforms. Includes an optional "Edit this Page" link. 📸 Docsify Open Publishing Screenshots --- ![ Docsify Open Publishing Starter Kit](https://raw.githubusercontent.com/paulhibbitts/github-repo-images/master/smartmockups_kud90vr6.png) _Figure 1. Docsify Open Publishing Starter Kit. Explore a demo at [hibbitts-design.github.io/demo-docsify-open-publishing-starter-kit/](https://hibbitts-design.github.io/demo-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) ![ Docsify Open Publishing Starter Kit - Install Page 1](https://raw.githubusercontent.com/paulhibbitts/github-repo-images/master/docsify-op-install-1.png) 2. Choose the name for your new repository to contain the copied site files and then tap **Create repository from template** ![ Docsify Open Publishing Starter Kit - Install Page 2](https://raw.githubusercontent.com/paulhibbitts/github-repo-images/master/docsify-op-install-2.png) 3. Go to **Settings** of your newly created repository, tap the **Pages** tab (on the left-hand side), choose **main branch**, then **docs folder** and finally tap the **Save** button (see more details in the [Docsify documentation](https://docsify.js.org/#/deploy?id=github-pages)) ![ Docsify Open Publishing Starter Kit - Install Page 3](https://raw.githubusercontent.com/paulhibbitts/github-repo-images/master/docsify-op-install-3.png) 4. And you're done! (view your new site using the provided URL on the **Pages** tab - it can take up to 10 minutes for your site to be initially available) ![ Docsify Open Publishing Starter Kit - Install Page 4](https://raw.githubusercontent.com/paulhibbitts/github-repo-images/master/docsify-op-install-4.png) Do you use GitLab? You can also use Docsify with [GitLab Pages](https://docsify.js.org/#/deploy?id=gitlab-pages)! ✏️ Editing Your Docsify Site Pages on GitHub --- 1. Go to the Docsify Markdown (.md) page in the `docs` folder of your repository you want to edit ![ Editing Your Docsify Site Pages 1](https://raw.githubusercontent.com/paulhibbitts/github-repo-images/master/docsify-page-edit-1.png) 2. Tap the **Pencil Icon** (top left-hand toolbar area) to start the editor ![ Editing Your Docsify Site Pages 2](https://raw.githubusercontent.com/paulhibbitts/github-repo-images/master/docsify-page-edit-2.png) 3. Scroll down to the bottom of the page and tap the **Commit changes** button to save your changes ![ Editing Your Docsify Site Pages 3](https://raw.githubusercontent.com/paulhibbitts/github-repo-images/master/docsify-page-edit-3.png) [Learn more about creating pages in Docsify.](https://docsify.js.org/#/more-pages) 🔗 Activating the “Edit this Page” on Your Docsify Site --- 1. At the top-level of your GitHub Repository copy the URL ![ Docsify Open Publishing Starter Kit - “Edit this Page” Link 1](https://raw.githubusercontent.com/paulhibbitts/github-repo-images/master/docsify-op-gitlink-1.png) 2. Tap on the **docs** folder ![ Docsify Open Publishing Starter Kit - “Edit this Page” Link 2](https://raw.githubusercontent.com/paulhibbitts/github-repo-images/master/docsify-op-gitlink-2.png) 2. Tap on the **index.html** file ![ Docsify Open Publishing Starter Kit - “Edit this Page” Link 3](https://raw.githubusercontent.com/paulhibbitts/github-repo-images/master/docsify-op-gitlink-3.png) 3. Tap the **Pencil Icon** (top left-hand toolbar area) to start the editor ![ Docsify Open Publishing Starter Kit - “Edit this Page” Link 4](https://raw.githubusercontent.com/paulhibbitts/github-repo-images/master/docsify-op-gitlink-4.png) 4. Find the line `var gitLinkRepoURL = '';` and enter the URL of your own GitHub Repository in between the two quotes and then scroll down to the bottom of the page and tap the **Commit changes** button to save your changes ![ Docsify Open Publishing Starter Kit - “Edit this Page” Link 5](https://raw.githubusercontent.com/paulhibbitts/github-repo-images/master/docsify-op-gitlink-5.png) 💻 Locally Editing Your Docsify Site Pages --- **Editing Your Docsify Site Pages on Your Desktop** 1. Tap **Code** on your repository (upper-right green button) 2. Choose **Open Desktop** and follow the prompts, installing [GitHub Desktop](https://desktop.github.com/) 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](https://atom.io/)) 4. Use GitHub Desktop to push any changes to your repository. [Learn more about using GitHub Desktop](https://help.github.com/en/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project). You can also clone (i.e download) a copy of your repository to your computer and [run Docsify locally](https://docsify.js.org/#/quickstart) to preview your site. See the below video for details. 🖼 Embedding Your Docsify Page Content into Other Systems --- ![ Docsify Open Publishing Page Ready for Embedding](https://raw.githubusercontent.com/paulhibbitts/github-repo-images/master/docsify-op-ready-for-embedding.png) _Figure 2. Docsify Open Publishing page ready for embedding_ 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/demo-docsify-open-publishing-starter-kit/#/chapter-1/introduction would display a standard Docsify page while https://hibbitts-design.github.io/demo-docsify-open-publishing-starter-kit/#/chapter-1/introduction?embedded=true would only display page content (i.e., no sidebar or optional navbar is shown). To optionally hide the 'Edit this Page' link, use the following: `?embedded=true&hidegitlink=true` For example, https://hibbitts-design.github.io/demo-docsify-open-publishing-starter-kit/#/chapter-1/introduction would display a standard Docsify page while https://hibbitts-design.github.io/demo-docsify-open-publishing-starter-kit/#/chapter-1/introduction?embedded=true&hidegitlink=true would only display page content (i.e., no sidebar or optional navbar is shown) and also hide the 'Edit this Page' link. 📚 Docsify and Markdown Resources --- **Docsify** [Docsify Documentation](https://docsify.js.org/#/?id=docsifyg) [Docsify Basics by MichaelCurrin](https://michaelcurrin.github.io/docsify-js-tutorial/#/?id=docsify-basics) **Docsify Themable** [Docsify Themeable Documentation](https://jhildenbiddle.github.io/docsify-themeable/#/introduction) [Docsify Themeable GitHub](https://github.com/jhildenbiddle/docsify-themeable) **Markdown** [Markdown Cheat Sheet](https://warpedvisions.org/projects/markdown-cheat-sheet/) [Markdown Guide](https://www.markdownguide.org/) 📼 Video Walkthrough of Local Docsify Install/Config --- [![Generating Documentation Sites with GitHub and Docsify - Alysson Alvaran](youtube.png)](https://www.youtube.com/watch?v=TV88lp7egMw) _Video 1. Generating Documentation Sites with GitHub and Docsify - Alysson Alvaran_ 🙇‍Credits and Special Thanks --- [Docsify Themeable](https://github.com/jhildenbiddle/docsify-themeable)