文件列表:

bin/
design/
tests/
LICENSE.txt
code-types.lisp
command-line.lisp
gen-script.sh
makefile
package.lisp
parse.lisp
srcweave.asd
tangle.lisp
textblock.lisp
toc.lisp
utils.lisp
weave.lisp

# srcweave `srcweave` is a [literate programming](https://en.wikipedia.org/wiki/Literate_programming) system for ANY programming language. `srcweave` helps you write code to be read by humans, not machines. **Features:** - Use any programming language for source. Write prose in markdown. - HTML documentation output with syntax highlighting (google-prettify) and math typesetting (KaTeX). - `make` friendly. Preserves file modification dates. - Cross-reference code across multiple files. - Compact UNIX philosophy design. Customize style and format with a shell script. ## Getting started **Requirements** - POSIX compliant system with tsort and shell. - `sbcl` with [quicklisp](https://quicklisp.org) installed - markdown (I recommend the `discount` implementation). **Install** Clone the project and run the following: make make install **Usage** 1. Create an `index.lit` file. For example: # Test Test console output: --- hello.js console.log("Hello, World!"); --- 2. Run `srcweave --tangle . index.lit` to generate source files (`hello.js`). 3. Run `srcweave --weave doc/ index.lit` to generate documentation (`index.html`). Both `--tangle` and `--weave` can be included in the same invocation. Multiple lit files can be specified, and the order they are listed in will determine the order of chapters and sections across files. **Formatting** The default HTML output is plain and unformatted. `srcweave` includes a UNIX style filter which provides nice output. To use it, you must first run srcweave-format-init docs/ This downloads all the necessary JavaScript/CSS dependencies for the project and only needs to be run once. Then specify the formatter on the weave command: srcweave --weave doc/ --formatter srcweave-format index.lit If you need to customize the HTML output beyond CSS, you are encouraged to copy the `srcweave-format` shell script to make your own. **Math typesetting** Include the `-m` flag on `srcweave-format-init` to download KaTex. See the examples for how to use `TeX` in .lit. ## .lit file examples The best part about .lit is you learn it just by reading the code! Here are a few basic examples to get started with: - [Hello world](https://github.com/justinmeiners/srcweave/tree/master/tests/hello/hello.lit) - [Basic features](https://github.com/justinmeiners/srcweave/tree/master/tests/basic/basic.lit) For more in-depth examples, see my article: - [Write your own Virtual Machine](https://github.com/justinmeiners/lc3-vm) ## Comparison with Literate srcweave is inspired by Zach Yedidia's [Literate](https://zyedidia.github.io/literate/). I like his program, have used it for several years, and am grateful for his contribution. However, I have since developed my own preferences and ideas for improvement: - Written in Common Lisp instead of D. This makes it more stable and portable (works on BSD, etc). - More modular UNIX design. srcweave completely delegates HTML formatting and libraries to a shell script. It provides high quality document output right out of the box, but is much easier to customize. - Simpler handling of multiple files. The "books" feature in Literate is a little cumbersome. In srcweave you can have multiple chapters in a single file, or divide them each into their own file. There is no distinction. - GPL license instead of MIT. srcweave is a program for end users. GPL should not restrict commercial use of the program while maximizing user freedom (contact me if you have an issue). The [vim plugin](https://github.com/zyedidia/literate.vim) should be compatible. **Known incompatibilities:** You can migrate files from Literate with only minor changes. Here are the important differences: - In literate, any block named with a file extension becomes a file. In srcweave, all file blocks must be prefixed with a path. For example `/out.txt` instead of `out.txt`. - formatting commands like `@add_css`, `@colorscheme` are ignored. Use the shared `.css` created by `srcweave-format-init` or a custom format script. - no support for books `@book`. Just pass multiple `.lit` files to the tool in the order you want. - no support for `@change` commands. Use shell scripts in your build process, instead. - `@title` only sets the page title, it does not create a heading. - Prefer markdown headings `# heading 1` and `## heading 2` instead of `@s`, etc. ## Acknowledgments Thanks to [Ryan Pendleton](https://github.com/rpendleton) for designing the document formatter. ## License [GPL 2](LICENSE.txt)

近期下载者：

相关文件：

评论：[我要评论] [举报此文件]

收藏者：