Commit master - Feedmark - git @ Cat's Eye Technologies

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

+10

-10

README.md less more

49	49
50	50	Loading documents will always check that they are minimally well-formed.
51	51
52		feedmark eg/*.md
	52	feedmark eg/\*.md
53	53
54	54	You can also check documents against a Feedmark schema, which is
55	55	simply another Feedmark document, one in which each entry describes
56	56	a property that entries should have.
57	57
58		feedmark eg/Sightings.md --check-against=eg/schema/Llama\ sighting.md
	58	feedmark eg/\Sightings\.md --check-against=eg/schema/Llama\ sighting.md
59	59
60	60	### Convert Feedmark documents to various formats
61	61

69	69	It can now also output entries as JSON, indexed by entry, or by
70	70	property, or by publication date:
71	71
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
75	75
76	76	Output entries as Markdown, or HTML (using the `toc` extension,
77	77	which generates link anchors on headings compatible with the ones
78	78	generated by GitHub).
79	79
80		feedmark --output-markdown eg/*.md
81		feedmark --output-html eg/*.md
	80	feedmark --output-markdown eg/\*.md
	81	feedmark --output-html eg/\*.md
82	82
83	83	### Rewrite documents in-place
84	84

87	87	it is recommended that the original files be under version control such
88	88	as `git`, which will easily allow the changes to be reverted if necessary.)
89	89
90		feedmark --rewrite-markdown eg/*.md
	90	feedmark --rewrite-markdown eg/\*.md
91	91
92	92	### Interlink documents
93	93

99	99	can be kept current and point to the canonical document in which the
100	100	entry exists, since it may exist in multiple, or be moved over time.
101	101
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
104	104
105	105	See also
106	106	--------