All Projects β†’ ThomasTJdev β†’ nimtomd

ThomasTJdev / nimtomd

Licence: MIT license
Convert a Nim file to Markdown

Programming Languages

nim
578 projects

Projects that are alternatives of or similar to nimtomd

Readme Md Generator
πŸ“„ CLI that generates beautiful README.md files
Stars: ✭ 9,184 (+70546.15%)
Mutual labels:  readme-md
The Documentation Compendium
πŸ“’ Various README templates & tips on writing high-quality documentation that people want to read.
Stars: ✭ 4,306 (+33023.08%)
Mutual labels:  readme-md
github-readme-quotes
Dynamic quote generator for your GitHub readmes | Give a poetic touch to readmes
Stars: ✭ 128 (+884.62%)
Mutual labels:  readme-md
jovanzers
Don't just fork, star it! πŸ‘€
Stars: ✭ 13 (+0%)
Mutual labels:  readme-md
readme-generator
πŸ“¦πŸ“ Personal generator to simply create cool and efficients README.md
Stars: ✭ 32 (+146.15%)
Mutual labels:  readme-md
SamirPaul1
πŸ€– My GitHub Profile README ✨
Stars: ✭ 26 (+100%)
Mutual labels:  readme-md
github-readme-linkedin
πŸ“‹ A serverless application to get dynamically generated images from your LinkedIn profile on your GitHub READMEs
Stars: ✭ 52 (+300%)
Mutual labels:  readme-md
midudev
This is my personal repo for README. It gets automatically updated to fetch latest videos, photos and articles from my blog.
Stars: ✭ 154 (+1084.62%)
Mutual labels:  readme-md
ayushi7rawat
Ayushi Rawat's README
Stars: ✭ 49 (+276.92%)
Mutual labels:  readme-md
bgoonz
https://bgoonz.github.io/bgoonz/
Stars: ✭ 13 (+0%)
Mutual labels:  readme-md
GOVINDDIXIT
GitHub Readme template to create your awesome introduction Readme on GitHub πŸš€
Stars: ✭ 18 (+38.46%)
Mutual labels:  readme-md
DenverCoder1
Jonah Lawrence's Profile README
Stars: ✭ 320 (+2361.54%)
Mutual labels:  readme-md
MakeNotes
πŸ“ Made a Note App . User can make important notes πŸ“‘as well as save it for future πŸ“† reference. You can mark importantβœ”οΈ as well as non important which makes it very easy to distinguish between different notesπŸ“°. (Html,Bootstrap,CSS,Javascript)
Stars: ✭ 18 (+38.46%)
Mutual labels:  readme-md

Nim to Markdown

Generated with Nim to Markdown

This Nim package converts Nim code to Markdown. Use nimtomd on your Nim file and transform it into a styled Markdown file.

You can choose to only include global elements (*) and top comments, or you can include everything.

Usage:

nimtomd [options] <filename>

Options:

Options:
<filename>                Nim-file to convert into markdown
-h,  --help               Shows the help menu
-o:, --output:[filename]  Outputs the markdown to a file
-ow, --overwrite          Allow to overwrite a existing md file
-g,  --onlyglobals        Only include global elements (*)
-sh                       Skip headings
-si                       Skip imports
-st                       Skip types
-il, --includelines       Include linenumbers
-ic, --includeconst       Include const
-il, --includelet         Include let
-iv, --includevar         Include var

Requirements

Your code needs to follow the Nim coding style. Checkout the source file for examples.

Examples

This README.md is made with nimtomd with the command:

nimtomd -o:README.md -ow -g nimtomd.nim

Output to screen

This prints the Markdown output to the screen:

nimtomd filename.nim

Save output to file

You can force nimtomd to overwrite an existing file by using the option -ow.

nimtomd -o:README.md -ow filename.nim
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].