Skip to content

Guides ideas

Needed guides

  • setup ssh config, ssh public key, etc
  • x forwarding through ssh session
  • remote desktop into linux, xrdp setup
  • PR keeping linear history by not merging branches, rebase instead

ToDo

  • set up mkdocs repo
  • add tilde pymdown extension for strikethrough text: https://yakworks.github.io/docmark/extensions/pymdown/ https://squidfunk.github.io/mkdocs-material/reference/formatting/
  • docker file for mkdocs project
  • local development using docker to run mkdocs
  • https://squidfunk.github.io/mkdocs-material/publishing-your-site/#material-for-mkdocs_1
  • github workflow to build gh-pages docs
  • git diagram example
  • multi repo mkdocs with CTJ and Website Wiki
  • Fang: it doesn't work correctly. All the links are broken. It imports the nav from the remote repos and converts the links to /, but the imported docs are stores in /docs/
  • https://github.com/jdoiro3/mkdocs-multirepo-plugin
  • HfLA Website Docs: '!import https://hackforla.github.io/CivicTechJobs/?branch=main'
  • HfLA Website Docs: '!import https://github.com/hackforla/website-wiki?branch=main'
  • material theme, mkdocs documentation
  • https://github.com/squidfunk/mkdocs-material
  • build and upload docker image to dockerhub and use that image for development
  • https://github.com/squidfunk/mkdocs-material/blob/master/.github/workflows/build.yml
  • try docker image on website-wiki to see if it works.