ExponentialDeepSpace / exponentialdeepspace.github.io

the main site.
http://exponentialdeepspace.org/
13 stars 4 forks source link

switch to docsify #1

Closed emptymalei closed 5 years ago

emptymalei commented 5 years ago

Changed

  1. kept all the contents from the master branch but switched from Jekyll to docsify.
  2. moved all documents into assets folder to keep organized
  3. added .gitingore
  4. added .nojekyll to stop gh pages from excluding files and folders with the underscore(_)

How to use

docsify renders your markdown contents directly using vue.js:

  1. _coverpage.md is used to render the splash page of the website: I added some random propaganda. it's very easy to change.
  2. _navbar.md can be used to assign links in the top nav bar
  3. _sidebar.md defines the sidebar on the left

Problem [SOLVED]

by default, docsify renders README.md as the index page. however, another index.md has been created.

i linked the about button on the front page to index.md which actually kills the slow scrolling effect. if the readme.md is used instead of the index.md file, the page will be slowly scrolled to the next page when the button about is clicked.

Comment

If a complicated website is so desirable, I can also create a Jekyll theme for that purpose. As for now, this website is simply some random pages. I would say it's ok to use docsify at this point. Switching to jekyll won't be too complicated.