Share your templates!

[rigwild]

If you made a custom template, do not hesitate to share it here! ⭐

Test your template

git clone [email protected]:rigwild/apidoc-markdown.git
# or
git clone https://github.com/rigwild/apidoc-markdown.git

cd apidoc-markdown
npm i -D
npm run build

# Create your template in the `templates` directory
node -e 'require("fs").writeFileSync("templates/custom.md", "# <%= project.name %> v<%= project.version %>")'

# Test your template, result in `output.md`
node bin/index.js -i test/_testFiles/input -t templates/custom.md -o output.md 

Share

Share it by copying the following:

# Purpose

This template shows...

# Template

````markdown
<!-- Paste your EJS template  here -->
# <%= project.name %> v<%= project.version %>

Description: <%= project.description %>
````

# Output below

---

<!-- Paste your output markdown here -->
# test v0.13.0

Description: RESTful web API Documentation Generator

[rigwild]

Example post

---

Purpose

This template shows...

Template

<!-- Paste your EJS template  here -->
# <%= project.name %> v<%= project.version %>

Description: <%= project.description %>

Output below

---

test v0.13.0

Description: RESTful web API Documentation Generator