`--generate`

The project templates are simple ourbigbook project directories that serve as good starting point for new ourbigbook projects.

They also contain useful examples of OurBigBook Markup usage to help users get started quickly.

Generate one of the template repositories locally:

ourbigbook --generate default: a good starter template that illustrates many key OurBigBook features
- github.com/ourbigbook/template
- ourbigbook.github.io/template
ourbigbook --generate min: a minimal template that is still sane
- github.com/ourbigbook/template-min
- ourbigbook.github.io/template-min
ourbigbook --generate subdir: a template in which OurBigBook source is located a subdirectory docs/:
- github.com/ourbigbook/template-subdir
- ourbigbook.github.io/template-subdir
This template illustrates that everything works exactly as if OurBigBook source were in the git repository toplevel.
This is a convenient setup for programming projects that want to use OurBigBook for their documentation without polluting their toplevel.

End users almost never want this, because it means that to have a sane setup you need to:

so maybe we should just get rid of that option and just ensure that we can provide an up-to-date working template for the latest relase.

For now we are keeping this as it is useful to automate the updating of templates during the release procedure.

 Ancestors (3)