Documentation plans

[lorenzoh]

Tutorials:

• [ ] Package documentation pt. 2: configuring a project and adding files
• [ ] Working with projects

How-to:

• [ ] How to configure documentation projects

Reference:

• [ ] Markdown syntax reference
• [ ] Formats reference
• [ ] Tree reference with related functions
• Interface documentation
  • [ ] Format
  • [ ] Rewriter
• Add/expand docstrings
  • [ ] SelectOr
  • [ ] XTree
  • [ ] cata
  • [ ] catafirst
  • [ ] catafold (examples)
  • [ ] replace/replacefirst (and After, Before, NthChild, FirstChild)
  • [ ] select/selectfirst
  • [ ] serve
  • [ ] withtag

[lorenzoh]

Suggestions for missing content welcome here!

[GTrunSec]

• Could we add some shortcut keys to the page? such as quickly closing the pop page
• Is it possible to use tree-greep to parse languages even having a common format interface by tree-sitter syntax?
• add shortcodes support in documents

[lorenzoh]

Hey there, thanks for chiming in!

Could we add some shortcut keys to the page? such as quickly closing the pop page

Do you mean closing the right-most open tab? Hotkeys are definitely something I want to add at some point. Do you have some more ideas? I was thinking to add the classic Ctrl+K to focus the search bar and maybe number keys to focus the n-th open tab.

Is it possible to use tree-greep to parse languages even having a common format interface by tree-sitter syntax?

For syntax highlighting or to completely support codebases in other languages? Should be doable with a Rewriter plugin.

add shortcodes support in documents

That's a cool library! I think this should actually work already if you return a short code from a julia code block marked as executable, since the ShortCodes can be rendered to text/html. So the following should work, though I haven't tried it:

{cell}
``julia
using ShortCodes
Twitter(1314967811626872842)
``

[GTrunSec]

For syntax highlighting or to completely support codebases in other languages? Should be doable with a Rewriter plugin.

Yeh, the code highlighting is necessary. but I mean the code.references that was in git-page..If I understood this feature correctly, it had implemented by Julia-synatx.jl? (with formats). So, how do you implement the same effect for other languages? Since a bit unrealistic to write the parsing of ast for each language, can we use the tree-greeper to achieve same things as code references?

[GTrunSec]

Do you mean closing the right-most open tab? Hotkeys are definitely something I want to add at some point. Do you have some more ideas? I was thinking to add the classic Ctrl+K to focus the search bar and maybe number keys to focus the n-th open tab.

• ESC (close the tab -> lose focus)
• Ctrl+s (focus the search bar )

Code reference

• Ctrl-: next code reference
• Ctrl- privous code refercne

Page

• Alt- next page
• Alt- privous page

n-th open tab.

• Ctrl-<1> jump to the first level subtitle of the current headline
• Alt-<1-xx> jump to first level headline.