https://github.com/nejcm/docz-theme-extended
Extended default theme for docz with added components and redesigned UI.
https://github.com/nejcm/docz-theme-extended
docs documentation docz gatsby-theme react theme
Last synced: about 1 year ago
JSON representation
Extended default theme for docz with added components and redesigned UI.
- Host: GitHub
- URL: https://github.com/nejcm/docz-theme-extended
- Owner: nejcm
- License: mit
- Created: 2020-05-17T10:41:00.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-07T12:54:20.000Z (about 2 years ago)
- Last Synced: 2025-03-21T05:33:33.864Z (over 1 year ago)
- Topics: docs, documentation, docz, gatsby-theme, react, theme
- Language: JavaScript
- Homepage: https://nejcm.github.io/docz-theme-extended/
- Size: 19.4 MB
- Stars: 63
- Watchers: 2
- Forks: 32
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ๐ docz-theme-extended
Extended default theme for docz with added components and redesigned UI.
[![version][version-badge]][package]
[![downloads][downloads-badge]][npmtrends]
[![MIT License][license-badge]][license]
[](#contributors)
[![PRs Welcome][prs-badge]][prs] [![Code of Conduct][coc-badge]][coc]
[![JavaScript Style Guide][style-guide-badge]][style-guide]
[![Watch on GitHub][github-watch-badge]][github-watch]
[![Star on GitHub][github-star-badge]][github-star]
## Table of Contents
- [Installation](#installation)
- [โญ๏ธ Features](#-features)
- [Docs & Examples](#docs--examples)
- [Issues](#issues)
- [๐ Bugs](#-bugs)
- [๐ก Feature Requests](#-feature-requests)
- [โ Questions](#-questions)
- [Authors](#authors)
- [Contributors](#contributors)
- [Support](#support)
- [LICENSE](#license)
## Installation
```bash
$ npm install --save @nejcm/docz-theme-extended
```
```js
// gatsby-config.js
module.exports = {
plugins: [
{
resolve: '@nejcm/docz-theme-extended',
},
],
};
```
You can read more about using themes at [Gatsby][gatsby-themes-instr].
## โญ๏ธ 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**][docs-link]
You can also check the **[demo][demo-link]** project inside this repo for code
examples and implementation details.
![Screenshot][screenshot]
## Issues
_Looking to contribute? Look for the [Good First Issue][good-first-issue]
label._
### ๐ Bugs
Please file an issue for bugs, missing documentation, or unexpected behavior.
[**See Bugs**][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**][requests]
### โ Questions
For questions related to using the library, please visit a support community
instead of filing an issue on GitHub.
## Authors
- Nejc Murลกiฤ ( [GitHub][github], [LinkedIn][linkedin] )
## Contributing
The repository is a monorepo containing two projects:
- theme: the extended docz theme
- demo: the demo and docs for the extended theme
```shell
# 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 Murลกiฤ
๐ป ๐ ๐ โ ๏ธ
ATAlgaba
๐ป
This project follows the [all-contributors][all-contributors] specification.
Contributions of any kind welcome!
## Support
Reach out to us at one of the following places:
- [๐ Website][website]
- [๐ง Email][email]
## LICENSE
[MIT](LICENSE)
[all-contributors]: https://github.com/all-contributors/all-contributors
[bugs]: https://github.com/nejcm/docz-theme-extended/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Acreated-desc
[build-badge]: https://img.shields.io/travis/com/nejcm/docz-theme-extended.svg
[build]: https://travis-ci.com/nejcm/docz-theme-extended
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg
[coc]: https://github.com/nejcm/docz-theme-extended/blob/master/CODE_OF_CONDUCT.md
[coverage-badge]: https://img.shields.io/codecov/c/github/nejcm/docz-theme-extended.svg
[coverage]: https://codecov.io/github/nejcm/docz-theme-extended
[demo-link]: https://github.com/nejcm/docz-theme-extended/tree/master/demo
[docs-link]: https://nejcm.github.io/docz-theme-extended/
[downloads-badge]: https://img.shields.io/npm/dm/@nejcm/docz-theme-extended.svg
[email]: nmursi2@gmail.com
[emojis]: https://github.com/all-contributors/all-contributors#emoji-key
[gatsby-themes-instr]: https://www.gatsbyjs.org/tutorial/using-a-theme/
[github]: https://github.com/nejcm
[github-star-badge]: https://img.shields.io/github/stars/nejcm/docz-theme-extended.svg?style=social
[github-star]: https://github.com/nejcm/docz-theme-extended/stargazers
[github-watch-badge]: https://img.shields.io/github/watchers/nejcm/docz-theme-extended.svg?style=social
[github-watch]: https://github.com/nejcm/docz-theme-extended/watchers
[good-first-issue]: https://github.com/nejcm/docz-theme-extended/issues?utf8=โ&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3A"good+first+issue"+
[license-badge]: https://img.shields.io/npm/l/@nejcm/docz-theme-extended.svg
[license]: https://github.com/nejcm/docz-theme-extended/blob/master/LICENSE
[linkedin]: https://www.linkedin.com/in/nejcm/
[node]: https://nodejs.org
[npm]: https://www.npmjs.com/
[npm-badge]: https://img.shields.io/npm/v/@nejcm/docz-theme-extended.svg
[npm-link]: https://www.npmjs.com/package/@nejcm/docz-theme-extended
[npmtrends]: http://www.npmtrends.com/@nejcm/docz-theme-extended
[package]: https://www.npmjs.com/package/@nejcm/docz-theme-extended
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
[prs]: http://makeapullrequest.com
[requests]: https://github.com/nejcm/docz-theme-extended/issues?q=is%3Aissue+sort%3Areactions-%2B1-desc+label%3Aenhancement+is%3Aopen
[screenshot]: https://raw.githubusercontent.com/nejcm/docz-theme-extended/master/screenshot.jpg
[semantic-release-badge]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-release]: https://github.com/semantic-release/semantic-release
[storybook-badge]: https://nejcmursic.netlify.com/assets/storybook.svg
[storybook]: https://storybook.js.org/
[style-guide-badge]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
[style-guide]: https://standardjs.com
[version-badge]: https://img.shields.io/npm/v/@nejcm/docz-theme-extended.svg
[website]: https://nejcmursic.com/