Code Monkey home page Code Monkey logo

docz-theme-extended's Introduction

๐ŸŽ€ docz-theme-extended

Extended default theme for docz with added components and redesigned UI.

version downloads MIT License

All Contributors

PRs Welcome Code of Conduct JavaScript Style Guide

Watch on GitHub Star on GitHub

Table of Contents

Installation

$ npm install --save @nejcm/docz-theme-extended
// gatsby-config.js
module.exports = {
  plugins: [
    {
      resolve: '@nejcm/docz-theme-extended',
    },
  ],
};

You can read more about using themes at Gatsby.

โญ๏ธ Features

  • Props table
  • Sticky headers navigation sidebar
  • Extended side menu that allows groups and sub-menus
  • Footer navigation to previous and next document
  • Optional fixed header
  • Custom header logo
  • Optional extended search that allows searching by tags
  • Custom components like: Tabs, Tag, Hint, InlineCode ...

Docs & Examples

Docs & Examples

You can also check the demo project inside this repo for code examples and implementation details.

Screenshot

Issues

Looking to contribute? Look for the Good First Issue label.

๐Ÿ› Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.

See Bugs

๐Ÿ’ก Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding a ๐Ÿ‘. This helps maintainers prioritize what to work on.

See Feature Requests

โ“ Questions

For questions related to using the library, please visit a support community instead of filing an issue on GitHub.

Authors

Contributing

The repository is a monorepo containing two projects:

  • theme: the extended docz theme
  • demo: the demo and docs for the extended theme
# Clone the project
git clone https://github.com/nejcm/docz-theme-extended.git my-project

# Install dependencies (yarn is required)
yarn install

# Run demo
yarn demo:dev

Check package.json file for more commands.

Contributors

Nejc
Nejc Murลกiฤ

๐Ÿ’ป ๐Ÿ“– ๐Ÿš‡ โš ๏ธ

ATAlgaba

๐Ÿ’ป

This project follows the all-contributors specification. Contributions of any kind welcome!

Support

Reach out to us at one of the following places:

LICENSE

MIT

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.