Updated documentation, added tree-sitter experiment
This commit is contained in:
25
planning/dsl.md
Normal file
25
planning/dsl.md
Normal file
@@ -0,0 +1,25 @@
|
||||
|
||||
## Example of indented block
|
||||
|
||||
```
|
||||
§ block
|
||||
this content
|
||||
is in the block body
|
||||
```
|
||||
|
||||
|
||||
## Inline
|
||||
|
||||
`«inline expression»`
|
||||
|
||||
## Escaping
|
||||
|
||||
|
||||
```
|
||||
«§» block
|
||||
|
||||
Here is an «la»inline expression«ra»
|
||||
Or possibly «outer escape: inline expression»
|
||||
|
||||
```
|
||||
|
||||
19
planning/to-document.md
Normal file
19
planning/to-document.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# Readme.md
|
||||
|
||||
In `readme.md` we should explain that `npm install` can be used both with and without development dependencies.
|
||||
|
||||
We are likely to want some development dependencies for the following purposes:
|
||||
|
||||
- Template processing
|
||||
- Ecmascript parsing for inline rich semantic documentation
|
||||
|
||||
|
||||
## Installing tree-sitter-javascript
|
||||
|
||||
- requires `node-gyp`
|
||||
|
||||
```sh
|
||||
CXXFLAGS="-std=c++20" npm i -D tree-sitter tree-sitter-javascript
|
||||
```
|
||||
|
||||
This section should be somewhat expanded - especially regarding node-gyp
|
||||
Reference in New Issue
Block a user