From b13895f29ee0cfd30a055d1a072847d75762987e Mon Sep 17 00:00:00 2001 From: Jen Looper Date: Thu, 21 Apr 2022 16:51:48 -0400 Subject: [PATCH] first pass at docsify --- README.md | 4 ++-- SECURITY.md => etc/SECURITY.md | 0 .nojekyll => etc/docsify/.nojekyll | 0 {docs => etc/docsify/docs}/_sidebar.md | 0 docsifytopdf.js => etc/docsify/docsifytopdf.js | 0 index.html => etc/docsify/index.html | 4 +++- package-lock.json => etc/docsify/package-lock.json | 0 package.json => etc/docsify/package.json | 0 {pdf => etc/pdf}/readme.pdf | Bin 9 files changed, 5 insertions(+), 3 deletions(-) rename SECURITY.md => etc/SECURITY.md (100%) rename .nojekyll => etc/docsify/.nojekyll (100%) rename {docs => etc/docsify/docs}/_sidebar.md (100%) rename docsifytopdf.js => etc/docsify/docsifytopdf.js (100%) rename index.html => etc/docsify/index.html (85%) rename package-lock.json => etc/docsify/package-lock.json (100%) rename package.json => etc/docsify/package.json (100%) rename {pdf => etc/pdf}/readme.pdf (100%) diff --git a/README.md b/README.md index 5ca6bce2..b4d7e408 100644 --- a/README.md +++ b/README.md @@ -139,13 +139,13 @@ We have chosen two pedagogical tenets while building this curriculum: ensuring t By ensuring that the content aligns with projects, the process is made more engaging for students and retention of concepts will be augmented. In addition, a low-stakes quiz before a class sets the intention of the student towards learning a topic, while a second quiz after class ensures further retention. This curriculum was designed to be flexible and fun and can be taken in whole or in part. The projects start small and become increasingly complex by the end of the 12 week cycle. -> Find our [Code of Conduct](etc/CODE_OF_CONDUCT.md), [Contributing](etc/CONTRIBUTING.md), and [Translation](etc/TRANSLATIONS.md) guidelines. Find our [Support Documentation here[(etc/SUPPORT.md). We welcome your constructive feedback! +> Find our [Code of Conduct](etc/CODE_OF_CONDUCT.md), [Contributing](etc/CONTRIBUTING.md), and [Translation](etc/TRANSLATIONS.md) guidelines. Find our [Support Documentation here](etc/SUPPORT.md) and [security information here](etc/SECURITY.md). We welcome your constructive feedback! > **A note about quizzes**: All quizzes are contained [in this app](https://black-ground-0cc93280f.1.azurestaticapps.net/), for 50 total quizzes of three questions each. They are linked from within the lessons but the quiz app can be run locally; follow the instruction in the `etc/quiz-app` folder. ## Offline access -You can run this documentation offline by using [Docsify](https://docsify.js.org/#/). Fork this repo, [install Docsify](https://docsify.js.org/#/quickstart) on your local machine, and then in the root folder of this repo, type `docsify serve`. The website will be served on port 3000 on your localhost: `localhost:3000`. +You can run this documentation offline by using [Docsify](https://docsify.js.org/#/). Fork this repo, [install Docsify](https://docsify.js.org/#/quickstart) on your local machine, and then in the `etc/docsify` folder of this repo, type `docsify serve`. The website will be served on port 3000 on your localhost: `localhost:3000`. ## Help Wanted! diff --git a/SECURITY.md b/etc/SECURITY.md similarity index 100% rename from SECURITY.md rename to etc/SECURITY.md diff --git a/.nojekyll b/etc/docsify/.nojekyll similarity index 100% rename from .nojekyll rename to etc/docsify/.nojekyll diff --git a/docs/_sidebar.md b/etc/docsify/docs/_sidebar.md similarity index 100% rename from docs/_sidebar.md rename to etc/docsify/docs/_sidebar.md diff --git a/docsifytopdf.js b/etc/docsify/docsifytopdf.js similarity index 100% rename from docsifytopdf.js rename to etc/docsify/docsifytopdf.js diff --git a/index.html b/etc/docsify/index.html similarity index 85% rename from index.html rename to etc/docsify/index.html index 55a0db8a..8ae047d1 100644 --- a/index.html +++ b/etc/docsify/index.html @@ -18,7 +18,9 @@ window.$docsify = { name: 'AI for Beginners', repo: 'https://github.com/Microsoft/AI-For-Beginners', - relativePath: true + relativePath: false, + basePath: 'https://raw.githubusercontent.com/microsoft/ai-for-beginners/main/', + auto2top: true } diff --git a/package-lock.json b/etc/docsify/package-lock.json similarity index 100% rename from package-lock.json rename to etc/docsify/package-lock.json diff --git a/package.json b/etc/docsify/package.json similarity index 100% rename from package.json rename to etc/docsify/package.json diff --git a/pdf/readme.pdf b/etc/pdf/readme.pdf similarity index 100% rename from pdf/readme.pdf rename to etc/pdf/readme.pdf