Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Advanced documentation #1

Open
8 of 10 tasks
badlydrawnrob opened this issue Jan 14, 2024 · 0 comments
Open
8 of 10 tasks

Advanced documentation #1

badlydrawnrob opened this issue Jan 14, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@badlydrawnrob
Copy link
Owner

badlydrawnrob commented Jan 14, 2024

Simplify! Build for your future stupid self.1

Issue: print-first-css and anki don't always update
Issue: Don't want to manually keep files up-to-date (between Anki and child theme)

  1. Add your package.json
  2. Use the default compiler, or the stripped down version2
  3. npm install3
  4. npm run setup4
  5. npm update anki
  6. npm update print-first-css
  7. npm run build5
  8. npm run pandoc5

Footnotes

  1. Removed Mustache from the child theme package.json

  2. The stripped down version compiles a lot less code, so is easier to read. This comes with the trade off that it doesn't look as pretty in the browser (for instance, the code highlighting .classes will be added, but you won't be able to preview it in the browser).

  3. Installs less, print-first-css and anki — there's an annoying problem when using npm with a GitHub repo, it doesn't always update and has to be done manually!!

  4. Creates our folders (with nothing in them)

  5. Compiles our css and the files in (6). pre.md is only for code snippets, whereas simple.md and simple-stripped.md compile all the Simple card data. 2

@badlydrawnrob badlydrawnrob added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant