CODEDOC - Creates beautiful and modern software documentation

  •        151

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.

https://codedoc.cc/
https://github.com/CONNECT-platform/codedoc/

Tags
Implementation
License
Platform

   




Related Projects

docbox - REST API documentation generator

  •    CSS

Docbox is an open source REST API documentation system. It takes structured Markdown files and generates a friendly two-column layout with navigation, permalinks, and examples. The documentation source files that Docbox uses are friendly for documentation authors and free of presentational code: it's Markdown. Docbox is a JavaScript application written with React. The core magic is thanks to the remark Markdown parser, which enables the layout: after parsing a file into an Abstract Syntax Tree, we can move examples to the right, prose to the left, and build the navigation system.

handbook - A gentle introduction to the art of Nodejitsu

  •    Javascript

Welcome to the Nodejitsu handbook. This document will help familiarize you with deploying your Node.js applications to the cloud while also providing detailed information about Nodejitsu's platform-specific features and about where to get help when you need it.Writing a new article is done by simply adding a Markdown file to a subdirectory. Several articles with related content can be placed under a seperate/new subdirectory. Only markdown files included in the catalog.

platyPS - Write PowerShell External Help in Markdown

  •    CSharp

Markdown help docs can be generated from old external help files (also known as MAML-xml help), the command objects (reflection), or both. PlatyPS can also generate cab files for Update-Help.

vue-styleguidist - Created from react styleguidist for Vue Components with a living style guide

  •    Javascript

Project was started when not finding a tool that generates documentation of components with hot reloading, read documentation and have a playground. Created from React Styleguidist, implement additional support to read and compile .vue files. Only supports 2.x. Vue Styleguidist is a style guide generator for Vue components. It lists component and shows live, editable usage examples based on Markdown files. You can use it to generate a static HTML page to share and publish or as a workbench for developing new components using hot reloaded dev server.

doctoc - 📜 Generates table of contents for markdown files inside local git repository

  •    Javascript

Generates table of contents for markdown files inside local git repository. Links are compatible with anchors generated by github or other sites via a command line flag. In its simplest usage, you can pass one or more files or folders to the doctoc command. This will update the TOCs of each file specified as well as of each markdown file found by recursively searching each folder. Below are some examples.


architecture-center - Azure Architecture Center

  •    Liquid

Some of the markdown files are generated from data stored in json files. This is primarily to avoid human error for pages that still require some HTML. The process that converts the json to markdown uses a utility script located in the build folder. To run the build script, navigate to the root folder of this repository. Microsoft and any contributors grant you a license to the Microsoft documentation and other content in this repository under the Creative Commons Attribution 4.0 International Public License, see the LICENSE file, and grant you a license to any code in the repository under the MIT License, see the LICENSE-CODE file.

academicmarkdown - Academic writing with Markdown

  •    Python

Academic Markdown is a Python module for generating .md, .html, .pdf, .docx, and .odt files from Markdown source. Pandoc is used for most of the heavy lifting, so refer to the Pandoc website for detailed information about writing in Pandoc Markdown. However, Academic Markdown offers some additional functionality that is useful for writing scientific documents, such as integration with Zotero references, and a number of useful Academic Markdown extensions. At present, the main target for Academic Markdown is the OpenSesame documentation site, http://osdoc.cogsci.nl/, although it may in time grow into a more comprehensive and user-friendly tool.

mdBook - Create book from markdown files. Like Gitbook but implemented in Rust

  •    Rust

mdBook is a utility to create modern online books from Markdown files. The User Guide for mdBook has been written in Markdown and is using mdBook to generate the online book-like website you can read. The documentation uses the latest version on GitHub and showcases the available features.

render-markdown-javascript - Renders markdown files to HTML with highlighted code blocks BUT ALSO RENDERS THE JAVASCRIPT ONES

  •    Javascript

Renders markdown files to HTML with highlighted code blocks BUT ALSO RENDERS THE JAVASCRIPT ONES. I've got a bunch of little JavaScript UI libs that don't need much more than a README.md for documentation, but a demo is worth a thousand README.md's, so I'd like the code in the README.md to actually render in a browser. Also great so people can copy/paste from the docs and know that it runs.

docs - Parse Platform docs

  •    CSS

These are the markdown sources for all of the Parse SDK guides. The content for the guides is stored in this repo, and we use Jekyll to generate a static site that is hosted on GitHub Pages. The guides are organized by platform. Each platform directory contains a set of markdown files, one for each main section in the guide.

JustWriting - markdown blog system

  •    PHP

Justwriting is a simple blog platform. You just need the text written in Markdown, upload the .md file to website, and it will show .md files as posts on your website. It can synchronize files to the server by Dropbox, so you don't have to care about losing your files when the server breaks, as all files can be stored on your local devices.

openKB - Open Source Nodejs Markdown based knowledge base (FAQ) app

  •    Javascript

openKB is a Markdown Knowledge base application (FAQ) built with Nodejs and ExpressJS. The application uses an embedded database (nedb) by default but can also use a MongoDB server by changing the config (see below). The application is designed to be easy to use and install and based around search rather than nested categories. Simply search for what you want and select from the results. Note: openKB supports Nodejs version 4.0 and above.

swagger2markup - A Swagger to AsciiDoc or Markdown converter to simplify the generation of an up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation

  •    Java

The primary goal of this project is to simplify the generation of an up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation produced by Swagger. The result is intended to be an up-to-date, easy-to-read, on- and offline user guide, comparable to GitHub’s API documentation. The output of Swagger2Markup can be used as an alternative to swagger-ui and can be served as static content. NOTE: The Swagger Specification has been donated to to the Open API Initiative (OAI) and has been renamed to the OpenAPI Specification. Swagger2Markup converts a Swagger JSON or YAML file into several AsciiDoc or GitHub Flavored Markdown documents which can be combined with hand-written documentation. The Swagger source file can be located locally or remotely via HTTP. Swagger2Markup supports the Swagger 1.2 and 2.0 specification. Internally it uses the official swagger-parser and my markup-document-builder.

markdown-mode - Emacs Markdown Mode

  •    Emacs

markdown-mode is a major mode for editing Markdown-formatted text. The latest stable version is markdown-mode 2.3, released on August 31, 2017. See the release notes for details. markdown-mode is free software, licensed under the GNU GPL, version 3 or later. The primary documentation for Markdown Mode is available below, and is generated from comments in the source code. For a more in-depth treatment, the Guide to Markdown Mode for Emacs covers Markdown syntax, advanced movement and editing in Emacs, extensions, configuration examples, tips and tricks, and a survey of other packages that work with Markdown Mode. Finally, Emacs is also a self-documenting editor. This means that the source code itself contains additional documentation: each function has its own docstring available via C-h f (describe-function), individual keybindings can be investigated with C-h k (describe-key), and a complete list of keybindings is available using C-h m (describe-mode).

dpdk-ovs - Open vSwitch accelerated by Intel® DPDK

  •    C

To get started right away, we recommend that you check out the documentation contained in the [`docs`][docs] directory. These files provide an in-depth overview of the components, system requirements and basic operation of Intel® DPDK vSwitch. The documents are written in Markdown format, so for best results, view the documentation using a Markdown viewer, or on [GitHub][docs].______

Gitiles - A simple JGit repository browser

  •    Java

Gitiles is a simple repository browser for Git repositories, built on JGit. Its guiding principle is simplicity: it has no formal access controls, no write access, no fancy Javascript, etc. Gitiles automatically renders *.md Markdown files into HTML for simplified documentation. Refer to the Markdown documentation for details.

dokka - Documentation Engine for Kotlin

  •    Kotlin

Dokka is a documentation engine for Kotlin, performing the same function as javadoc for Java. Just like Kotlin itself, Dokka fully supports mixed-language Java/Kotlin projects. It understands standard Javadoc comments in Java files and KDoc comments in Kotlin files, and can generate documentation in multiple formats including standard Javadoc, HTML and Markdown. The plugin adds a task named "dokka" to the project.

DocumentJS - The sophisticated documentation engine

  •    Javascript

DocumentJS creates beautiful, articulate, multi-versioned documentation. With DocumentJS, you can Write documentation inline or in markdown files, Specify your code's behavior precisely with JSDoc and Google Closure Compiler annotations, Customize your site's theme and layout, Generate multi-version documentation.

godocdown - Format package documentation (godoc) as GitHub friendly Markdown

  •    Go

-- Command godocdown generates Go documentation in a GitHub-friendly Markdown format. This program is targeted at providing nice-looking documentation for GitHub. With this in mind, it generates GitHub Flavored Markdown (http://github.github.com/github-flavored-markdown/) by default. This can be changed with the use of the "plain" flag to generate standard Markdown.