Install and build documentation (beginner and advanced)

[badlydrawnrob]

Simplify this issue down to a single paragraph!!

Change terminology for documentation to easy and hard (so-so isn't very helpful)

• [ ] #42 (A simple update guide like the release)
• [ ] #97
• [ ] Simplify initial README so it's easier to digest
  • Show it, don't say it? Add some gifs like below
  • User pain points. i.e: install without breaking things.
  • [ ] Update the professional docs
• [ ] #104
• [ ] #55 Build folder and basic npm scripts explained in a very simple way
  • Most of the build stuff in print-first-css can be hidden
  • Like a module, some bits are hidden and not extendable.
  • Remember the problems with print-first-css and npm with GitHub repos!
• [ ] Other package.json related issues
  • #102
  • #96
• [ ] #71
• [ ] Issues should probably be handled better
  • Simple enough to not scare kids off
  • Yet thorough enough for my own purposes ...
  • Nice example of a gitbot issue auto-responder

Already thought about ...

• [x] Build script and security notes (Pandoc, Less CSS, Print First CSS)
  • [ ] Build passing and other shields (thanks @callmemarcleo)
  • [x] Using semantic versioning properly
  • [x] Be very careful about mustache and JSON formatting using the demo files — especially things like the {{cloze:tag}} demo
  • [x] Demo is useful for now, but involves copying (and slightly editing) the main Card themes in source/themes/demo/...
• [x] Saner internal links? (rather than them scattered in various places)
  • [x] You can actually hover over a link in Visual Studio Code (see below)
  • [x] An online tool (it indexes all Github's links too, not just the README ☹️)
  • [ ] ❓Using a link checker tool (Marked App only checks external links)
  • [ ] 💩 Or a CLI tool (too many depencies / a ballache to set up)
• [x] Generate PDF

🏆 cmd ⌘ + click: Turns the link blue and takes you to the correct .md page!

Use a CLI tool: 34 bloody dependencies to check your links

https://github.com/badlydrawnrob/anki/assets/1176875/e3813b95-0f4f-439e-ae7c-0c41f7ab36e1

Create a gif how to video with this convertor