-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
02ec53a
commit d9e6a1d
Showing
3 changed files
with
52 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
|project| | ||
========= | ||
|
||
A command line tool for running commands against documentation files. | ||
|
||
.. include:: install.rst | ||
|
||
.. include:: usage-example.rst | ||
|
||
What does it work on? | ||
--------------------- | ||
|
||
* reStructuredText (`.rst`) | ||
|
||
.. code-block:: rst | ||
.. code-block:: shell | ||
echo "Hello, world!" | ||
* Markdown (`.md`) | ||
|
||
.. code-block:: markdown | ||
```shell | ||
echo "Hello, world!" | ||
``` | ||
* MyST (`.md` with MyST syntax) | ||
|
||
.. code-block:: markdown | ||
```{code-block} shell | ||
echo "Hello, world!" | ||
``` | ||
* Want more? Open an issue! | ||
|
||
Reference | ||
--------- | ||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
|
||
install | ||
usage-example | ||
commands | ||
contributing | ||
release-process | ||
changelog |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters