Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add back markdown files #5064

Merged
merged 17 commits into from
Apr 16, 2024
7 changes: 7 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -413,8 +413,15 @@ module.exports = {
files: ['**/*.md', '*.md'],
processor: 'markdown/markdown',
},
{
files: ['docs/**/*.md/*.js'],
parserOptions: {
sourceType: 'module',
},
},
{
files: ['**/*.md/*.js', '**/*.md/*.javascript'],
excludedFiles: ["docs/**/*"],
parserOptions: {
sourceType: 'module',
},
Expand Down
21 changes: 21 additions & 0 deletions .github/workflows/linters.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,24 @@ jobs:
run: corepack yarn workspaces focus @uppy-dev/build
- name: Run linter
run: corepack yarn run lint:markdown

lint_docs:
name: Lint Docs
runs-on: ubuntu-latest
steps:
- name: Checkout Uppy.io sources
uses: actions/checkout@v3
with:
repository: transloadit/uppy.io
- run: rm -rf docs # the other PR has not landed
- name: Checkout docs
uses: actions/checkout@v3
with:
path: uppy
- run: mv uppy /tmp/uppy && ln -s /tmp/uppy/docs docs
- name: Install dependencies
run: corepack yarn --immutable
- name: Lint files
run: corepack yarn lint
- name: Test build website
run: corepack yarn build
7 changes: 7 additions & 0 deletions .prettierrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,12 @@ module.exports = {
semi: true,
},
},
{
files: "docs/**",
options: {
semi: true,
useTabs: true,
}
}
],
}
3 changes: 3 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Uppy documentation

To build the documentation, see <https://github.com/transloadit/uppy.io>.
Loading
Loading