https://github.com/josemarluedke/docfy

Build fully personalized documentation sites; write content and demos in Markdown.
https://github.com/josemarluedke/docfy

docs documentation-builder ember ember-addon emberjs javascript site-builder typescript

Last synced: 5 days ago
JSON representation

Build fully personalized documentation sites; write content and demos in Markdown.

• Host: GitHub
• URL: https://github.com/josemarluedke/docfy
• Owner: josemarluedke
• License: mit
• Created: 2020-04-10T03:02:54.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-02-19T18:55:41.000Z (11 months ago)
• Last Synced: 2025-01-01T09:55:09.808Z (11 days ago)
• Topics: docs, documentation-builder, ember, ember-addon, emberjs, javascript, site-builder, typescript
• Language: TypeScript
• Homepage: https://docfy.dev
• Size: 4.02 MB
• Stars: 74
• Watchers: 6
• Forks: 26
• Open Issues: 33
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        




  

  



Docfy is a modular JavaScript tool to help build documentation sites. Its core

has all the essential features to help you create a full-featured docs app while

writing all your content in Markdown.

## Documentation

Visit [docfy.dev](https://docfy.dev/) to read the docs and see live demos.

## Usage

### Core

The example below uses TypeScript.

```ts

import Docfy from '@docfy/core';

import path from 'path';

import hbs from 'remark-hbs';

import autolinkHeadings from 'remark-autolink-headings';

const projectRoot = '../tests/__fixtures__/monorepo/';

const root = path.resolve(__dirname, projectRoot);

(async function (): Promise {

  const docfy = new Docfy({

    remarkPlugins: [[autolinkHeadings, { behavior: 'append' }], hbs]

  });

  const docs = await docfy.run([

    {

      root,

      urlPrefix: 'docs',

      urlSchema: 'manual',

      pattern: '**/*.md'

    }

  ]);

  console.log(docs);

})();

```

## Compatibility

- Node.js v12 or above

## License

This project is licensed under the [MIT License](LICENSE.md).