Skip to content

Commit

Permalink
DEVDOCS-4719: [migrate] Upgrade docs to new Dev Center syntax and spe…
Browse files Browse the repository at this point in the history
…c standards (#58)

Co-authored-by: Sarah Riehl <[email protected]>
Co-authored-by: Traci Porter <[email protected]>
Co-authored-by: Andrea Dao <[email protected]>
Co-authored-by: Tina Gomez <[email protected]>
Co-authored-by: Constanze Kratel <[email protected]>
Co-authored-by: Mark Murphy <[email protected]>
Co-authored-by: Katie Hoesley <[email protected]>
Co-authored-by: Stephen Hilliard <[email protected]>
Co-authored-by: Heather Barr <[email protected]>
Co-authored-by: Matthew Volk <[email protected]>
Co-authored-by: Nate Stewart <[email protected]>
  • Loading branch information
11 people committed Mar 10, 2023
1 parent bfe016f commit 6aa40a0
Show file tree
Hide file tree
Showing 15 changed files with 3,478 additions and 43 deletions.
10 changes: 10 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"extends": ["plugin:mdx/recommended"],
// optional, if you want to lint code blocks at the same time
"settings": {
"mdx/code-blocks": true,
// optional, if you want to disable language mapper, set it to `false`
// if you want to override the default language mapper inside, you can provide your own
"mdx/language-mapper": {}
}
}
18 changes: 18 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: lint-valid-mdx

on:
pull_request:
branches: [migrate-DEVDOCS-4719]

jobs:
lint:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Use Node.js v17.x
uses: actions/setup-node@v3
with:
node-version: 17.x
- run: npm ci
- run: npm run lint
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

.idea
node_modules
.DS_Store
56 changes: 28 additions & 28 deletions examples/banners.md → examples/banners.mdx
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
```json
{
"banners": {
"bottom": [
"<div id='1370512507'></div>"
],
"bottom_metadata": [
{
"banner-name": "Example Bottom Banner",
"content": "",
"id": "3",
"location": "bottom"
}
],
"top": [
"<div id='2102203073'></div>"
],
"top_metadata": [
{
"banner-name": "Example Top Banner",
"content": "",
"id": "2",
"location": "top"
}
]
}
}
```
```json filename="banners" showLineNumbers copy
{
"banners": {
"bottom": [
"<div id='1370512507'></div>"
],
"bottom_metadata": [
{
"banner-name": "Example Bottom Banner",
"content": "",
"id": "3",
"location": "bottom"
}
],
"top": [
"<div id='2102203073'></div>"
],
"top_metadata": [
{
"banner-name": "Example Top Banner",
"content": "",
"id": "2",
"location": "top"
}
]
}
}
```
Loading

0 comments on commit 6aa40a0

Please sign in to comment.