Skip to content

How to add a Plugin Manual #430

@rgleason

Description

@rgleason

What you need is a [Plugin name_pi] Manual that uses your github repo and asciidoc/antora and will be linked to the opencpn/plugin repository by Mike Rossiter [rasbats] so that it becomes a part of the Plugins manual here

https://opencpn-manuals.github.io/main/opencpn-plugins/index.html

Here is ocpn_draw manual as HTML: https://opencpn-manuals.github.io/main/odraw/index.html
Here is the github ocpn_draw manual source docs: https://github.com/jongough/ocpn_draw_pi/tree/master/manual

Here is the full plugins manual as Html: https://opencpn-manuals.github.io/main/opencpn-plugins/index.html

Also see this repo: https://github.com/opencpn-manuals
Basically all the separate plugin manuals are kept in their individual repositories, then asciidoc/antora regularly assembles those sources into one source that becomes the Plugin manual.

In the Opencpn Wiki we keep a list with links directly to the plugins
https://opencpn.org/wiki/dokuwiki/doku.php?id=opencpn:manual_basic:set_options:plugin_manager
We will add crowdsource_pi when you have a manual done.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions