This repository has been archived by the owner on Jan 24, 2025. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of github.com:pedronauck/docz into feat/dark-mode
* 'master' of github.com:pedronauck/docz: (36 commits) v0.2.11 fix: some changes on css examples fix(docz-plugin-css): production build fix(docz-core): node env for production fix(docz-theme-default): use webfontloader instead of css import chore: update readme v0.2.10 chore(docz-plugin-css): typo readme chore(docz-plugin-css): change readme feat(docz-plugin-css): add initial version (#78) chore: update badges on readme chore: update readme chore: contributing typos chore: add code conduct chore: update readme chore: update contributors chore: update readme chore: add contributing and contributors chore: add commitizen chore: add husky, lint staged and commitlint ...
- Loading branch information
Showing
110 changed files
with
4,472 additions
and
460 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| { | ||
| "projectName": "docz", | ||
| "projectOwner": "pedronauck", | ||
| "repoType": "github", | ||
| "repoHost": "https://github.com", | ||
| "badgeTemplate": "", | ||
| "files": [ | ||
| "README.md", | ||
| "CONTRIBUTING.md" | ||
| ], | ||
| "imageSize": 60, | ||
| "commit": true, | ||
| "contributors": [ | ||
| { | ||
| "login": "pedronauck", | ||
| "name": "Pedro Nauck", | ||
| "avatar_url": "https://avatars3.githubusercontent.com/u/2029172?v=4", | ||
| "profile": "https://github.com/pedronauck", | ||
| "contributions": [ | ||
| "question", | ||
| "bug", | ||
| "code", | ||
| "doc", | ||
| "ideas", | ||
| "plugin", | ||
| "review", | ||
| "test" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "renatorib", | ||
| "name": "Renato Ribeiro", | ||
| "avatar_url": "https://avatars2.githubusercontent.com/u/3277185?v=4", | ||
| "profile": "http://twitter.com/renatorib_", | ||
| "contributions": [ | ||
| "code", | ||
| "doc", | ||
| "bug" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "marceloavf", | ||
| "name": "Marcelo Formentão", | ||
| "avatar_url": "https://avatars3.githubusercontent.com/u/5435657?v=4", | ||
| "profile": "https://github.com/marceloavf", | ||
| "contributions": [ | ||
| "code", | ||
| "bug" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "Swapnull", | ||
| "name": "Martyn Rushton", | ||
| "avatar_url": "https://avatars0.githubusercontent.com/u/4456346?v=4", | ||
| "profile": "http://swapnull.co.uk", | ||
| "contributions": [ | ||
| "code" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "good-idea", | ||
| "name": "Joseph Thomas", | ||
| "avatar_url": "https://avatars3.githubusercontent.com/u/11514928?v=4", | ||
| "profile": "https://www.good-idea.studio", | ||
| "contributions": [ | ||
| "code" | ||
| ] | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # Contributor Covenant Code of Conduct | ||
|
|
||
| ## Our Pledge | ||
|
|
||
| In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. | ||
|
|
||
| ## Our Standards | ||
|
|
||
| Examples of behavior that contributes to creating a positive environment include: | ||
|
|
||
| * Using welcoming and inclusive language | ||
| * Being respectful of differing viewpoints and experiences | ||
| * Gracefully accepting constructive criticism | ||
| * Focusing on what is best for the community | ||
| * Showing empathy towards other community members | ||
|
|
||
| Examples of unacceptable behavior by participants include: | ||
|
|
||
| * The use of sexualized language or imagery and unwelcome sexual attention or advances | ||
| * Trolling, insulting/derogatory comments, and personal or political attacks | ||
| * Public or private harassment | ||
| * Publishing others' private information, such as a physical or electronic address, without explicit permission | ||
| * Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
|
||
| ## Our Responsibilities | ||
|
|
||
| Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. | ||
|
|
||
| Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. | ||
|
|
||
| ## Scope | ||
|
|
||
| This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. | ||
|
|
||
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. | ||
|
|
||
| Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. | ||
|
|
||
| ## Attribution | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] | ||
|
|
||
| [homepage]: http://contributor-covenant.org | ||
| [version]: http://contributor-covenant.org/version/1/4/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| # Contributing | ||
|
|
||
| Contributions, issues and feature requests are very welcome. If you are using this package and fixed a bug for yourself, please consider submitting a PR! Also you can ping me at [Twitter](https://twitter.com/pedronauck) | ||
|
|
||
| ## Guidelines | ||
|
|
||
| If you will develop some pull request, it's very important follow these basic rules: | ||
|
|
||
| ### Commit messages | ||
|
|
||
| Commit messages should follow the [commit message convention](https://conventionalcommits.org/) so that changelogs can be automatically generated. Commit messages will be automatically validated upon commit. If you are not familiar with the commit message convention, you can use `yarn commit` instead of `git commit`, which provides an interactive CLI for generating proper commit messages. | ||
|
|
||
| ### General guidelines | ||
|
|
||
| - The master branch is basically just a snapshot of the latest stable release. All development should be done in dedicated branch. **Do not submit PRs against the master branch.** | ||
| - Checkout a topic branch from the relevant branch, e.g. `dev`, and merge back against that branch. | ||
| - Work in the **src** folder of respective package and **DO NOT** checkin dist in the commits. | ||
| - It's OK - and a very nice thing - to have multiple small commits as you work on the PR - we will let GitHub automatically squash it before merging. | ||
|
|
||
| ### If adding new feature: | ||
|
|
||
| - Make sure that [all examples](https://github.com/pedronauck/docz/tree/master/examples) are running as expected | ||
| - Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it greenlighted before working on it. | ||
|
|
||
| ## Setup | ||
|
|
||
| ### Pre-requisites | ||
|
|
||
| - *Node:* `^9.0.0` | ||
| - *Yarn:* `^1.7.0` | ||
|
|
||
| ### Install | ||
|
|
||
| Check out the code and go into the docz directory: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/pedronauck/docz.git | ||
| cd docz | ||
| ``` | ||
|
|
||
| Then run yarn install and bootstrap all packages: | ||
|
|
||
| ```bash | ||
| $ yarn install | ||
| $ yarn bs | ||
| ``` | ||
|
|
||
| After that, just run `packages` script to format, build and lint all packages: | ||
|
|
||
| ```bash | ||
| $ yarn packages | ||
| ``` | ||
|
|
||
| ## Developing | ||
|
|
||
| There's just few things that you need to know to start developing on docz | ||
|
|
||
| ### Project structure | ||
|
|
||
| There's a lot of [packages](https://github.com/pedronauck/docz/tree/master/packages) that are necessary to run docz, but basically has just two that you need to know more about: | ||
|
|
||
| #### **[docz-core](https://github.com/pedronauck/docz/tree/master/packages/docz)** | ||
| - This is the core of docz. All build algorithms, server process and parses belongs to here. | ||
| - If you break this package, probably you'll break all packages! Please, be carefull. | ||
| - All cli commands are built here and imported on `docz` package using `./bin` script. | ||
| - Do not create scripts that's running on browser here, just node scripts. | ||
|
|
||
| #### **[docz](https://github.com/pedronauck/docz/tree/master/packages/docz)** | ||
| - Main and top level package. | ||
| - Scripts that's running on browser belongs to this package | ||
| - Built-ins components are built here, most specifically on [this folder](https://github.com/pedronauck/docz/tree/master/packages/docz/src/components) | ||
| - This package shouldn't have any component style, just boilerplate and logic! | ||
|
|
||
| ### Watching projects | ||
|
|
||
| To speed up your develop process: | ||
| - Split your terminal openning the packages that you need to develop and running `yarn dev` in each window. | ||
| - After that, use any of this splitted window to run `yarn dev` in some [example](https://github.com/pedronauck/docz/tree/master/examples) to run it, like that: | ||
|
|
||
|  | ||
|
|
||
| Now you're watching `docz`, `docz-core` and `docz-theme-default` and running `docz-example-basic`. So, any modificationmade on any package will reflect on basic example on the fly! | ||
|
|
||
| ### Creating plugins | ||
|
|
||
| If has some plugin that you want to create, please contact-me before to talk about the possibility to make this plugin official! | ||
|
|
||
| ## Contributors | ||
|
|
||
| Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)): | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
| <!-- prettier-ignore --> | ||
| | [<img src="https://avatars3.githubusercontent.com/u/2029172?v=4" width="60px;"/><br /><sub><b>Pedro Nauck</b></sub>](https://github.com/pedronauck)<br />[💬](#question-pedronauck "Answering Questions") [🐛](https://github.com/pedronauck/docz/issues?q=author%3Apedronauck "Bug reports") [💻](https://github.com/pedronauck/docz/commits?author=pedronauck "Code") [📖](https://github.com/pedronauck/docz/commits?author=pedronauck "Documentation") [🤔](#ideas-pedronauck "Ideas, Planning, & Feedback") [🔌](#plugin-pedronauck "Plugin/utility libraries") [👀](#review-pedronauck "Reviewed Pull Requests") [⚠️](https://github.com/pedronauck/docz/commits?author=pedronauck "Tests") | [<img src="https://avatars2.githubusercontent.com/u/3277185?v=4" width="60px;"/><br /><sub><b>Renato Ribeiro</b></sub>](http://twitter.com/renatorib_)<br />[💻](https://github.com/pedronauck/docz/commits?author=renatorib "Code") [📖](https://github.com/pedronauck/docz/commits?author=renatorib "Documentation") [🐛](https://github.com/pedronauck/docz/issues?q=author%3Arenatorib "Bug reports") | [<img src="https://avatars3.githubusercontent.com/u/5435657?v=4" width="60px;"/><br /><sub><b>Marcelo Formentão</b></sub>](https://github.com/marceloavf)<br />[💻](https://github.com/pedronauck/docz/commits?author=marceloavf "Code") [🐛](https://github.com/pedronauck/docz/issues?q=author%3Amarceloavf "Bug reports") | [<img src="https://avatars0.githubusercontent.com/u/4456346?v=4" width="60px;"/><br /><sub><b>Martyn Rushton</b></sub>](http://swapnull.co.uk)<br />[💻](https://github.com/pedronauck/docz/commits?author=Swapnull "Code") | [<img src="https://avatars3.githubusercontent.com/u/11514928?v=4" width="60px;"/><br /><sub><b>Joseph Thomas</b></sub>](https://www.good-idea.studio)<br />[💻](https://github.com/pedronauck/docz/commits?author=good-idea "Code") | | ||
| | :---: | :---: | :---: | :---: | :---: | | ||
| <!-- ALL-CONTRIBUTORS-LIST:END --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.