All Projects β†’ interactivethings β†’ Catalog

interactivethings / Catalog

Licence: bsd-3-clause
Create living style guides using Markdown or React

Programming Languages

javascript
184084 projects - #8 most used programming language
typescript
32286 projects

Projects that are alternatives of or similar to Catalog

Vuesence Book
Minimalistic Vue.js based documentation system component
Stars: ✭ 48 (-96.86%)
Mutual labels:  documentation, docs, documentation-tool, markdown
Docsify
πŸƒ A magical documentation site generator.
Stars: ✭ 19,310 (+1164.57%)
Mutual labels:  documentation, docs, documentation-tool, markdown
Vue Styleguidist
Created from react styleguidist for Vue Components with a living style guide
Stars: ✭ 2,133 (+39.69%)
Mutual labels:  documentation, markdown, styleguide, style-guide
Community
Modern Confluence alternative designed for internal & external docs, built with Golang + EmberJS
Stars: ✭ 1,286 (-15.78%)
Mutual labels:  documentation, docs, documentation-tool
Docpht
With DocPHT you can take notes and quickly document anything and without the use of any database.
Stars: ✭ 90 (-94.11%)
Mutual labels:  documentation, docs, documentation-tool
Markdown Guide
The comprehensive Markdown reference guide.
Stars: ✭ 835 (-45.32%)
Mutual labels:  documentation, documentation-tool, markdown
Pdoc
API Documentation for Python Projects
Stars: ✭ 853 (-44.14%)
Mutual labels:  documentation, docs, documentation-tool
Livingstyleguide
Easily create front-end style guides with Markdown and Sass/SCSS.
Stars: ✭ 874 (-42.76%)
Mutual labels:  documentation-tool, styleguide, style-guide
App
Fast and searchable Ruby docs
Stars: ✭ 47 (-96.92%)
Mutual labels:  documentation, docs, documentation-tool
Docnado
Rapid documentation tool that will blow you away...
Stars: ✭ 67 (-95.61%)
Mutual labels:  documentation, docs, markdown
Docsify Tabs
A docsify.js plugin for rendering tabbed content from markdown
Stars: ✭ 65 (-95.74%)
Mutual labels:  documentation, docs, markdown
Swift
Airbnb's Swift Style Guide.
Stars: ✭ 1,165 (-23.71%)
Mutual labels:  markdown, styleguide, style-guide
Devdocs
API Documentation Browser
Stars: ✭ 27,208 (+1681.79%)
Mutual labels:  documentation, docs, documentation-tool
Pdoc
🐍 ➑️ πŸ“œ Auto-generate API documentation for Python projects
Stars: ✭ 604 (-60.45%)
Mutual labels:  documentation, docs, documentation-tool
Jekyll Rtd Theme
Just another documentation theme compatible with GitHub Pages
Stars: ✭ 92 (-93.98%)
Mutual labels:  documentation, docs, documentation-tool
Bluedoc
An open-source document management tool for enterprise self host.
Stars: ✭ 579 (-62.08%)
Mutual labels:  documentation, docs, markdown
Verb
HEADS UP! Verb is going though a major transition, we've completely refactored everything from the ground up. If you're interested, please see the dev branch.
Stars: ✭ 442 (-71.05%)
Mutual labels:  documentation, docs, markdown
Zeal
Offline documentation browser inspired by Dash
Stars: ✭ 9,164 (+500.13%)
Mutual labels:  documentation, docs, documentation-tool
Mdx Docs
πŸ“ Document and develop React components with MDX and Next.js
Stars: ✭ 412 (-73.02%)
Mutual labels:  documentation, docs, markdown
The Documentation Compendium
πŸ“’ Various README templates & tips on writing high-quality documentation that people want to read.
Stars: ✭ 4,306 (+181.99%)
Mutual labels:  documentation, docs, documentation-tool

Catalog Logo

Travis Downloads Version License

🚧 This is the currently in-development v4 branch. Stable code is in master.

Catalog

Catalog lets you create beautiful living and fully interactive style guides using Markdown and React components.

Please read the Catalog documentation (built with Catalog!) for detailed installation and usage instructions.

Installation

yarn

yarn add catalog react react-dom

npm

npm install catalog react react-dom --save

Development

Please make sure that you have Node >= 6 and yarn installed.

Build process

Start the build process in watch mode:

make

Docs

To edit Catalog documentation, run:

make docs

Note: this uses the local Catalog build from dist/. Run make before/alongside make docs.

Linking

When developing Catalog you want to link it locally:

yarn link

You can then link to this version in your project (or one of the examples):

yarn link catalog

Tests

To run Jest tests in watch mode:

make test-watch

Creating a Release

Bump Catalog's version:

make version

Then push including tags:

git push && git push --tags

The CI server will automatically run tests, build and publish the new version to npm

CI commands

These usually run automatically on the CI server

Create a build

make build

Create a documentation build

make build-docs

Publish to npm and generate GitHub release notes

make publish

Credits

Catalog is developed by many people at Interactive Things, a User Experience and Data Visualization Studio based in ZΓΌrich.

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].