Star

MIT License
Copyright © 2020
CONNECT-platform

header

header

CODEDOC is an open-source tool that helps you with creating beautiful and modern software documentation. It creates a JAMStack app from your markdown files that you can easily deploy on services such as GitHub Pages.

1linknpm i -g @codedoc/cli # --> click on each line to copy it


linkUsage

Assume you have a repo on github named my-project and want to write documentations for it using codedoc. Install the codedoc cli, clone your repo locally, then:

1linkcd my-project # --> go to your project folder

2linkcodedoc init # --> initialize codedoc

3linkcodedoc serve # --> serve the docs

Open a browser on the URL the CLI tool tells you (e.g. localhost:3000/my-project) and see the docs boilerplate.

Your markdown files by default are located at docs/md/, for example the main page you see will be from docs/md/index.md. The table of contents will also by default be on docs/md/_toc.md. Modify them and see the changes in realtime.


linkPublishing

When you are done with your docs and want to publish them, say to GitHub Pages, simply run this command in your project folder:

1linkcodedoc build # --> build the docs for deployment

Then add all the built files and push to GitHub:

1linkgit add -A # --> add your built files

2linkgit commit -m "meine docs" # --> commit the changes

3linkgit push # --> push to the cloud

Remember to enable GitHub Pages on your repo.


linkFeatures

This very documentation was created using codedoc, so basically every feature you see here you would get for your own documentation. Check out this repository to see how exactly these documentations were created using codedoc.


linkEnhanced Markdown

1linkHi _this_ is my content, and let me have some buttons beneath it:

2link

3link> :Buttons <!--> this is how you use custom components -->

4link> > :Button icon=true, label=share, url=https://twitter.com <!--> this `Button` component is a child of the `Buttons` component -->

5link>

6link> > :Button label=Google!, url=https://stackblitz.com <!--> this other `Button` is also part of the parent `Buttons` component -->

Hi this is my content, and let me have some buttons beneath it:

shareGoogle!

Learn More

linkEnhanced Code Snippets

1linkSo I have some code with enhanced features here:

2link```tsx

3link/*!*/import { build } from '@codedoc/core'; // --> programmatically import codedoc

4link/*!*/import { join } from 'path'; // @see [official docs](https://nodejs.org/api/path.html)

5link

6linkfunction doStuff() { // --> this function does stuff.

7link console.log('Lets see the markdown again'); // @see tab:the markdown

8link/*-*/ console.log('This line is removed');

9link/*+*/ console.log('This line is added');

10link

11link this./*~*/methodWithErrors()/*~*/;

12link}

13link```

14link> :Buttons

15link> > :CopyButton

So I have some code with enhanced features here:

1linkimport { build } from '@codedoc/core'; // --> programmatically import codedoc

2linkimport { join } from 'path'; // @see [official docs](https://nodejs.org/api/path.html)

3link

4linkfunction doStuff() { // --> this function does stuff.

5link console.log('Lets see the markdown again'); // @see tab:the markdown

6link console.log('This line is removed');

7link console.log('This line is added');

8link

9link this.methodWithErrors~~~~~~~~~~~~~~~~(~)~;

10link}


Learn More

linkCustomizability

Easily change any aspect of your docs, from theme colors and fonts to meta data of each page and their layouts. Create your own custom header or ToC with JSX/TSX-based components, or use custom JSX-TSX-based components in your markdown.

The component-based structure of codedoc simply means that you can even re-use your custom components across different projects, or you can publish them (for example to NPM) so that other people can enjoy them too!


If your project is on GitHub, codedoc by default includes a cross-docs search functionality using GitHub search API. You can also easily integrate your own search APIs into the default search components (besides being able to actually use your own custom search components).

The same search functionality is used on this documentation. You can check it out by clicking on the menu icon in the footer and opening the search functionality.


linkIntegrated Dark Mode

Its 2020, and dark-mode should be considered a universal right! Codedoc supports dark-mode on all your docs. Device settings is used by default, while allowing your readers to manually override this.


linkCollaborative

Everything is markdown, so you can easily work on a project's documentation with your peers using any version control software like Git. No need for half-baked weird visual interfaces on top!


linkOpen-Source

Codedoc is an open-source tool, completely free-to-use, MIT-licensed, no strings attached. I simply needed this tool to write usable docs for some open-source projects I was working on.

UsagePublishingFeaturesEnhanced MarkdownEnhanced Code SnippetsCustomizabilityIntegrated SearchIntegrated Dark ModeCollaborativeOpen-Source

Home Overview CLI Theme

Markdownchevron_right
Code Featureschevron_right

Images & Assets

Configurationchevron_right
Customizationchevron_right