Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@huksley/markdoc

Package Overview
Dependencies
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@huksley/markdoc

Creates Confluence markdown documentation from jsdoc and markdown files

  • 0.2.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
1
Weekly downloads
 
Created
Source

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 

FAQs

Package last updated on 15 Feb 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc