🌟 docsify-course

Everything required to add a Docsify site to ACS course repos.

Table of Contents

1. Features
2. Prerequisites
3. Installation
4. Deployment
5. Additional Resources

Features

Includes the following features built in:

• Websites available offline.
• Ability to search and display any .md file in your repo linked in _sidebar.md.
• Syntax highlighting for multiple programming languages
• Emojis in the following format :100:.
• Added functionality: Copy to Clipboard function, flexible alerting.

Prerequisites

1. Install docsify-cli: npm install -g docsify-cli.
2. (Optional) Install npm install -g tocsify to generate directory-based sidebars.

Installation

1. Download the latest release in the Releases tab.
2. Unzip the downloaded file.
3. Move _navbar.md, _sidebar.md, .nojekyll, index.html, and the Web folder to your local course repository.
4. IMPORTANT: **Update _sidebar.md with course materials that you want searchable.**m
5. Open index.html in a text editor.
   1. Scroll down and replace REPO_NAME on lines 24-27 and 43 with the repo name for your course (ex: BEW-2.5-Strongly-Typed-Ecosystems)
   2. Finally, update lines 6 through 11 and 41 with relevant information for your course.
6. use <!-- tabs:start --> and <!-- tabs:end --> to tabulate sections of your syllabus.
7. Test locally by running docsify serve . in the root of the repo.
8. Add, commit, and push your changes to origin/master.

Deployment

1. Navigate to the Settings tab of your course repository.
2. Scroll down to the GitHub Pages settings.
   1. Select master in the Source drop-down.
   2. Submit to enable GitHub Pages for your repo.
3. Click the resulting https://tech-at-du.github.io link to test the deployment.

Additional Resources

• Docsify Documentation