Skip to content
🌟Everything required to add a Docsify site to Make School course repos.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Web
.gitignore
.nojekyll
LICENSE
README.md
_navbar.md
_sidebar.md
index.html

README.md

docsify-course

🌟Everything required to add a Docsify site to Make School course repos.

Features

Includes the following features built in:

  • Make School theme.
  • Websites available offline.
  • Ability to search and display any .md file in your repo linked in _sidebar.md.
  • Syntax highlighting for 23 different languages used at Make School.
  • 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.

Update Your Repo - Step by Step

  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.
  5. Open index.html in a text editor.
    1. Scroll down and replace REPO_NAME on lines 40 and 63 with the repo name for your course (ex: BEW-2.5-Strongly-Typed-Ecosystems)
    2. Finally, scroll up and update lines 6 through 11 in index.html with relevant descriptions for your course.
  6. Test locally by running docsify serve . in the root of the repo.
  7. 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://Make-School-Courses.github.io link to test the deployment.
  4. Update shortlinks to match the following format:
    1. make.sc/bew1.2 points to the course website: https://Make-School-Courses.github.io/BEW-1.2-Authentication-and-Associations
    2. make.sc/bew1.2-repo points to the GitHub repo: https://github.com/Make-School-Courses/BEW-1.2-Authentication-and-Associations

Additional Resources

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.