mirror of
https://github.com/jxnblk/mdx-deck.git
synced 2024-09-11 14:46:02 +03:00
Adjust build and add contributing doc
This commit is contained in:
parent
4f8adbaae9
commit
7bc118fb64
@ -1,3 +1,4 @@
|
||||
src
|
||||
site
|
||||
docs
|
||||
coverage
|
||||
|
107
CONTRIBUTING.md
Normal file
107
CONTRIBUTING.md
Normal file
@ -0,0 +1,107 @@
|
||||
|
||||
# Contributing
|
||||
|
||||
Thanks for contributing!
|
||||
|
||||
Please take a look at the issues and PRs to see if there's already some discussion around any contribution you'd like to make.
|
||||
If you'd like to make a significant change to the code base, please open an issue for discussion first,
|
||||
otherwise we'd love to have your help!
|
||||
|
||||
## Development
|
||||
|
||||
1. Clone the repo
|
||||
2. Install dependencies with `npm install`
|
||||
3. Build with `npm run prepare`
|
||||
4. Run `npm start` to see the demo `docs/index.mdx`
|
||||
|
||||
### Watch mode
|
||||
|
||||
To watch files for changes during development, run `npm run watch`
|
||||
|
||||
## Testing
|
||||
|
||||
Tests are located in the [`test/`](test) directory.
|
||||
|
||||
Run `npm test`
|
||||
|
||||
- Watch Mode: `npm test -- --watch`
|
||||
- Coverage: `npm test -- --coverage`
|
||||
|
||||
|
||||
---
|
||||
|
||||
# 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, sex characteristics, gender identity and expression,
|
||||
level of experience, education, socio-economic status, 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 [INSERT EMAIL ADDRESS]. All
|
||||
complaints will be reviewed and investigated and will result in a response that
|
||||
is deemed necessary and 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
|
5
cli.js
5
cli.js
@ -53,9 +53,6 @@ const getConfig = conf => {
|
||||
]
|
||||
}
|
||||
]
|
||||
conf.module.rules[1].include.push(
|
||||
path.join(__dirname, './src')
|
||||
)
|
||||
|
||||
return conf
|
||||
}
|
||||
@ -119,7 +116,7 @@ const doc = file || cmd
|
||||
if (!doc) cli.showHelp(0)
|
||||
|
||||
const opts = Object.assign({
|
||||
entry: path.join(__dirname, './src/entry.js'),
|
||||
entry: path.join(__dirname, './dist/entry.js'),
|
||||
dirname: path.dirname(path.resolve(doc)),
|
||||
globals: {
|
||||
DOC_FILENAME: JSON.stringify(path.resolve(doc))
|
||||
|
@ -1,5 +1,5 @@
|
||||
export { future as theme } from '../src/themes'
|
||||
import { Image, Notes, Appear } from '../src'
|
||||
export { future as theme } from '../dist/themes'
|
||||
import { Image, Notes, Appear } from '../dist'
|
||||
import Layout from './Layout'
|
||||
|
||||
# mdx-deck
|
||||
|
@ -7,7 +7,9 @@
|
||||
"mdx-deck": "./cli.js"
|
||||
},
|
||||
"scripts": {
|
||||
"prepare": "babel src -d dist",
|
||||
"prepare": "npm run babel",
|
||||
"babel": "babel src -d dist",
|
||||
"watch": "babel src -d dist --watch",
|
||||
"start": "./cli.js docs/index.mdx -p 8989",
|
||||
"build": "./cli.js build docs/index.mdx -d site",
|
||||
"pdf": "./cli.js pdf docs/index.mdx -d site",
|
||||
|
Loading…
Reference in New Issue
Block a user