boltex / leojs

Leo Literate Editor with Outline in Typescript
https://marketplace.visualstudio.com/items?itemName=boltex.leojs
MIT License
25 stars 1 forks source link

Using myLeojs.leo and leojs.leo. #14

Closed edreamleo closed 7 months ago

edreamleo commented 3 years ago

leojs.leo is the "official" .leo file for this project.

Individual contributors should make a copy of leojs.leo, called myLeojs.leo, for their own use. .gitignore ignores myLeojs.leo, so you can change it freely.

Important: leojs.leo uses @clean for all files. This means that all collaborators should keep the outline structure of all external files in sync! Otherwise, the @clean update algorithm will "assign" lines to the wrong nodes when reading @clean files. So the rule is:

Update leojs.leo whenever adding, moving or deleting nodes in an @clean tree.

It is easy to update leojs.leo from myLeojs.leo. Just use @button write-leojs. This script writes the top-level 'Startup', 'Documentation', and 'Code' nodes to leojs.leo. The script checks that it is, in fact, being run from myLeojs.leo.