git @ Cat's Eye Technologies Feedmark / master
Placate the Cheese Shop's readme_renderer. Chris Pressey 6 months ago
1 changed file(s) with 10 addition(s) and 10 deletion(s). Raw diff Collapse all Expand all
4949
5050 Loading documents will always check that they are minimally well-formed.
5151
52 feedmark eg/*.md
52 feedmark eg/\*.md
5353
5454 You can also check documents against a Feedmark schema, which is
5555 simply another Feedmark document, one in which each entry describes
5656 a property that entries should have.
5757
58 feedmark eg/*Sightings*.md --check-against=eg/schema/Llama\ sighting.md
58 feedmark eg/\*Sightings\*.md --check-against=eg/schema/Llama\ sighting.md
5959
6060 ### Convert Feedmark documents to various formats
6161
6969 It can now also output entries as JSON, indexed by entry, or by
7070 property, or by publication date:
7171
72 feedmark --output-json eg/*.md
73 feedmark --by-property eg/*.md
74 feedmark --by-publication-date eg/*.md
72 feedmark --output-json eg/\*.md
73 feedmark --by-property eg/\*.md
74 feedmark --by-publication-date eg/\*.md
7575
7676 Output entries as Markdown, or HTML (using the `toc` extension,
7777 which generates link anchors on headings compatible with the ones
7878 generated by GitHub).
7979
80 feedmark --output-markdown eg/*.md
81 feedmark --output-html eg/*.md
80 feedmark --output-markdown eg/\*.md
81 feedmark --output-html eg/\*.md
8282
8383 ### Rewrite documents in-place
8484
8787 it is recommended that the original files be under version control such
8888 as `git`, which will easily allow the changes to be reverted if necessary.)
8989
90 feedmark --rewrite-markdown eg/*.md
90 feedmark --rewrite-markdown eg/\*.md
9191
9292 ### Interlink documents
9393
9999 can be kept current and point to the canonical document in which the
100100 entry exists, since it may exist in multiple, or be moved over time.
101101
102 feedmark eg/*.md --output-refdex >refdex.json
103 feedmark --input-refdex=refdex.json --rewrite-markdown eg/*.md
102 feedmark eg/\*.md --output-refdex >refdex.json
103 feedmark --input-refdex=refdex.json --rewrite-markdown eg/\*.md
104104
105105 See also
106106 --------