Date
1 - 1 of 1
possibilities for breaking .md doc files into bite-sized pieces?
rpjday@crashcourse.ca <rpjday@...>
i'm still working my way through the doc files, and it *appears*
that there is no (simple) markdown-related way to have a main file
include subfiles as can be done in .rst files. this is going to be an
issue as some of the .md files are getting sizable (peers/peers.md is
already well over 500 lines), and the longer those files get, the
harder it is to make even minor changes to them without possibly
clashing with someone else's work.
the one obvious solution is what one can see in command_ref.rst,
which uses reST to do the partitioning:
Commands Reference
==================
.. toctree::
:maxdepth: 1
commands/peercommand.md
commands/peerchaincode.md
commands/peerchannel.md
commands/peerversion.md
commands/peerlogging.md
commands/peernode.md
commands/configtxgen.md
commands/configtxlator.md
commands/cryptogen.md
commands/fabric-ca-commands
in any event, i think some of the markdown files are getting to the
point where there's some value in breaking them into smaller parts for
convenience.
thoughts?
rday
that there is no (simple) markdown-related way to have a main file
include subfiles as can be done in .rst files. this is going to be an
issue as some of the .md files are getting sizable (peers/peers.md is
already well over 500 lines), and the longer those files get, the
harder it is to make even minor changes to them without possibly
clashing with someone else's work.
the one obvious solution is what one can see in command_ref.rst,
which uses reST to do the partitioning:
Commands Reference
==================
.. toctree::
:maxdepth: 1
commands/peercommand.md
commands/peerchaincode.md
commands/peerchannel.md
commands/peerversion.md
commands/peerlogging.md
commands/peernode.md
commands/configtxgen.md
commands/configtxlator.md
commands/cryptogen.md
commands/fabric-ca-commands
in any event, i think some of the markdown files are getting to the
point where there's some value in breaking them into smaller parts for
convenience.
thoughts?
rday