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

Documentation improvements #19

Closed
OliverBalfour opened this issue Apr 15, 2021 · 0 comments
Closed

Documentation improvements #19

OliverBalfour opened this issue Apr 15, 2021 · 0 comments
Milestone

Comments

@OliverBalfour
Copy link
Owner

OliverBalfour commented Apr 15, 2021

  • Add example files for each export format to an examples subfolder
  • Add instructions for how to write for each export type
    • Slideshow formats use --- (ie <hr>) to demarcate slides
    • You can use ---\ntitle: my title\n--- YAML frontmatter
  • Explain what sort of new workflows this plugin enables
    • Writing books - just use ![[Chapter1]] ![[Chapter2]] ... and export as PDF/ePub/Word/etc
    • Fancy presentations - explain Reveal.js
    • Drafting LaTeX documents and eBooks
    • Making static websites (like Obsidian publish, but you can put them on a USB drive or use GitHub Pages/Jekyll)
    • Writing assignments in Obsidian and exporting them to whatever format you need them in
    • Explain obscure export types and why they're worth using
    • Writing Word documents without Word
    • Ultimately, it lets you do more inside Obsidian (centralised PKMS) and in a simpler interface, and still interface with the outside world
  • Update the list of caveats and the screenshot
  • Mention you can put tags in YAML frontmatter to hide them in the output
  • Mention Plugin doesn't recognize pandoc or MacTeX on mac #15 and the fix for it if it's just a PATH configuration issue
@OliverBalfour OliverBalfour added this to the 0.2.0 milestone Apr 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant