script/doc

#!/bin/bash -ex

# Generate some specific files with docgen.
go install ./internal/cmd/docgen

suite="tests/thirdparty/suite.json"
docgen -suite "${suite}" -type readme -output README.md
docgen -suite "${suite}" -type adopters -output doc/adopters.md

# Process simple file embeddings with embedmd.
find . -name '*.md' | xargs embedmd -w
doc: scripts to run embedmd on markdown files This will help keep READMEs in sync with code. Also adds a README for the add example. Updates #14 2018-12-31 20:25:29 -08:00			`#!/bin/bash -ex`

doc: generate README with docgen tool (#251) Introduces a docgen tool for templated documentation generation, and uses it to generate the README. At the moment this change makes minimal difference to generating it with embedmd. The difference is that docgen opens up the possibility to generate documentation with more elaborate templating. The specific use case currently in mind is including an adopters list that's kept in sync with the third-party packages file. Updates #101 2022-04-17 19:41:29 -07:00			`# Generate some specific files with docgen.`
			`go install ./internal/cmd/docgen`

tests/thirdparty: use Suite type for configuration (#285) 2022-05-08 16:55:51 -07:00			`suite="tests/thirdparty/suite.json"`
			`docgen -suite "${suite}" -type readme -output README.md`
			`docgen -suite "${suite}" -type adopters -output doc/adopters.md`
doc: generate README with docgen tool (#251) Introduces a docgen tool for templated documentation generation, and uses it to generate the README. At the moment this change makes minimal difference to generating it with embedmd. The difference is that docgen opens up the possibility to generate documentation with more elaborate templating. The specific use case currently in mind is including an adopters list that's kept in sync with the third-party packages file. Updates #101 2022-04-17 19:41:29 -07:00
			`# Process simple file embeddings with embedmd.`
doc: scripts to run embedmd on markdown files This will help keep READMEs in sync with code. Also adds a README for the add example. Updates #14 2018-12-31 20:25:29 -08:00			`find . -name '*.md' \| xargs embedmd -w`