Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 1.87 KB

README.md

File metadata and controls

59 lines (37 loc) · 1.87 KB

You can find the original README.md info for the microbit-pxt from which this repo is forked at ORIGINAL_REPO_README.md Original Readme

Working on the Teknikio Documentation

  • Make sure to checkout a new branch before editing:
git checkout -b YOUR_NAME/WHAT_YOURE_DOING
  • Install pxt on your computer
npm install -g pxt
  • Install dependencies
npm install
  • Run local develpoment server
pxt serve

To edit this page, you need to edit the corresponding Markdown file, it will have the same name as the last portion of the url, but will end in .md instead of .html. So to edit this page I would need to edit on-start.md

  • Edit a Markdown file .md. You can use a code editor like VSCode to view a preview as you edit the file.

  • Once your edits are complete, open a pull request to master. After it's been merged, follow the steps below to deploy new changes.

How to deploy new changes

  • Once the changes are ready, run
pxt staticpkg

  • Copy the generated files from /built/packaged/docs to the Teknikio.github.io repository

  • Avoid copying the full folder if you can and try to retrieve only the relevant files from the built output. For example, if you edit on-start.md, try to only copy over on-start.html and on-start.md

  • The folder structure in Teknikio.github.io follows the same structure under /built/packaged in the pxt-docs repository. This means the following file in pxt-docs: -- built/packaged/docs/about.html can be found in Teknikio.github.io under -- /docs/about.html

  • Cache might take a few minutes to clear the old stuff, so keep reloading to see your changes.

  • Make sure to commit your files on both repos.