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

Document org-mode support #313

Closed
3 tasks
srid opened this issue Jul 29, 2020 · 1 comment
Closed
3 tasks

Document org-mode support #313

srid opened this issue Jul 29, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@srid
Copy link
Owner

srid commented Jul 29, 2020

  • How to enable org-mode support in neuron.dhall
  • How to link between notes
  • Mention limitations if any (are there? @felko ?)

brief explanation

Org-mode support is disabled by default. To enable it, add formats = ["markdown", "org"] in the neuron.dhall file. Then neuron will pickup .org files as well as .md files. To link to notes, use [[z:/efja2hs3]] syntax (explain why this particular syntax).

@srid srid added the documentation Improvements or additions to documentation label Jul 29, 2020
@felko
Copy link
Contributor

felko commented Jul 29, 2020

Mention limitations if any

Yes there are, so far I found only those two:

  • Headline links ([[*Headline title]]): not even generated as links, rendered as slanted text
  • Fuzzy linking ([[file:path::Some sentence somewhere in the file]]):: generated as links but doesn't work

I would expect both linked headlines and sentences to be generated along with HTML anchors and so that links can point to them.

I'm not an org-mode power user so I suspect many other features that I didn't notice won't work. I think the support it is good enough for basic usage but it is just impossible to reimplement org-mode entirely within neuron. I'll try to investigate alternatives such as letting emacs handle itself the HTML generation through a custom exporter tailored for neuron.

@srid srid closed this as completed Dec 22, 2020
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
Projects
None yet
Development

No branches or pull requests

2 participants