Doco is a Makefile for building DocoSite website . It provides utility targets for linting and releasing DocoSite website projects.
Have a look at DocoExample as an example project which uses Doco.
- Download
src/Makefile-docoas theMakefileof your project:curl https://raw.githubusercontent.com/cliffano/doco/main/src/Makefile-doco -o Makefile - Create configuration file
doco.ymlwith properties described in Configuration section - Run the available
Makefiletargets described in Usage section
Create Doco configuration file called doco.yml with contains the following properties:
| Property | Description | Example |
|---|---|---|
| generator.component | The generator component type from generator-website | doco-site |
| generator.inputs.project_id | The project ID | somedocosite |
| generator.inputs.project_name | The project display name | Some DocoSite |
| generator.inputs.project_desc | The project description | A sample DocoSite website |
| generator.inputs.author_name | The author's name | Some Author |
| generator.inputs.author_email | The author's email address | someauthor@example.com |
| generator.inputs.github_id | The GitHub user or organisation ID | pakkunbot |
| generator.inputs.github_repo | The GitHub repository name | docoexample |
The following targets are available:
| Target | Description |
|---|---|
| ci | CI target to be executed by CI/CD tool, end to end build of the DocoSite |
| deps-extra-apt | Retrieve dependencies requiring installation using apt |
| lint | Run lint checks against Markdown files using markdownlint |
| release-major | Create a major release using rtk |
| release-minor | Create a minor release using rtk |
| release-patch | Create a patch release using rtk |
Related Projects:
- generator-website - Website projects generator using Plop