@huksley/markdoc

0.2.0 • Public • Published

Makedoc

Creates markdown documentation ready to be uploaded to Confluence using mark tool.

Scans folder to create Markdown files to be uploaded. Supports package.json/makedoc section.

Configure mark

cat ~/.config/mark
username = "user.name@domain.com" 
password = "123"
base_url = "https://workspace.atlassian.net/wiki"

Configure your project package.json

{
  ...
  makedoc: {
    gitBaseUrl: "https://github.com/huksley/makedoc/",
    config.confluenceSpaceId: "Docs", 
    config.rootFolder: ".",
    ignoredMarkdownFiles: ["PULL_REQUEST_TEMPLATE.md", "CODEOWNERS.md", "LICENSE.md", "CONTRIBUTING.md" ],
    output: "out",
    exclude: "node_modules",
    title: "makedoc", // {basename rootFolder}
    jsdoc: []// [{ dir: "doc", title: "Docs" }]
  }
  ...
}

Running

node ../makedoc/index 

Readme

Keywords

none

Package Sidebar

Install

npm i @huksley/markdoc

Weekly Downloads

0

Version

0.2.0

License

ISC

Unpacked Size

10.5 kB

Total Files

4

Last publish

Collaborators

  • huksley