README.md

changeset 24
4013d2901832
parent 21
3c71c525cec2
equal deleted inserted replaced
23:0ea4b0786b43 24:4013d2901832
18 and LaTeX mathematics via 18 and LaTeX mathematics via
19 [markdown-it][] and [KaTeX][] or [Pandoc][]. Markdown-it is now the default renderer. To select lua-markdown, use `renderer: lua-markdown` in the page YAML meta section. Use `renderer: pandoc` for Pandoc. 19 [markdown-it][] and [KaTeX][] or [Pandoc][]. Markdown-it is now the default renderer. To select lua-markdown, use `renderer: lua-markdown` in the page YAML meta section. Use `renderer: pandoc` for Pandoc.
20 20
21 ## Installation 21 ## Installation
22 22
23 You need to install [Lua 5.3][Lua]. 23 You need to install [Lua 5.3][Lua] and [LuaFileSystem][], e.g. using
24 [LuaRocks][]):
25 ```sh
26 $ luarocks install luafilesystem
27 ```
24 To use [markdown-it][], you need to install [NodeJS][] and then execute `npm install` to install in the top directory of this project. 28 To use [markdown-it][], you need to install [NodeJS][] and then execute `npm install` to install in the top directory of this project.
25 29
26 ## License 30 ## License
27 31
28 Aside from the included `compat_env.lua` and the ltp engine (which is has not 32 Aside from the included `compat_env.lua` and the ltp engine (which is has not
32 [KaTeX]: https://katex.org/ 36 [KaTeX]: https://katex.org/
33 [markdown-it]: https://github.com/markdown-it/markdown-it 37 [markdown-it]: https://github.com/markdown-it/markdown-it
34 [Pandoc]: https://pandoc.org/ 38 [Pandoc]: https://pandoc.org/
35 [Lua]: http://www.lua.org/ 39 [Lua]: http://www.lua.org/
36 [NodeJS]: https://nodejs.org/en/ 40 [NodeJS]: https://nodejs.org/en/
41 [LuaRocks]: https://luarocks.org/
42 [LuaFileSystem]: http://keplerproject.github.io/luafilesystem/

mercurial