Skip to content
This repository has been archived by the owner on Oct 9, 2024. It is now read-only.

Latest commit

 

History

History
204 lines (151 loc) · 7.41 KB

README.md

File metadata and controls

204 lines (151 loc) · 7.41 KB

🎀 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