Skip to content

Commit

Permalink
feat(website): introduce website prototype using docusaurus (#80)
Browse files Browse the repository at this point in the history
This pull request introduces several changes to integrate Docusaurus
into the project, update configurations, and add new documentation and
blog content. The most important changes are grouped by theme and listed
below:

### Docusaurus Integration:
* Added Docusaurus patterns to the `dependabot.yml` file to manage
dependencies (`.github/dependabot.yml`).
* Updated `.markdownlintignore` and `.prettierignore` to include
`.docusaurus` directory (`.markdownlintignore`, `.prettierignore`).
[[1]](diffhunk://#diff-b5e89e929d119744a043caea30a5e49d7a9ea25e3253755760d5b6ec9bd24ca0R7)
[[2]](diffhunk://#diff-b640b344ee7f3f03d2a443795a5d0708ef50e2e6e34214109ab2aad13ad6ba98R7)
* Added new blog posts, authors, and tags for Docusaurus
(`website/blog/`, `website/blog/authors.yml`, `website/blog/tags.yml`).
[[1]](diffhunk://#diff-13ef6905839196bfa8884f7ed9279214ab38a26bd8b969cd6a621e6d215b0e5bR1-R12)
[[2]](diffhunk://#diff-bc019287f354ff32519ca13a919dc0dfa870ae7a4b04e2a2de53a9ed0cda87d2R1-R44)
[[3]](diffhunk://#diff-4f260ec1a3033bc612a365fc187ce771a2fd0aebfa92b6ae78c7b8b3d4b3f341R1-R24)
[[4]](diffhunk://#diff-3c1f462aac6184c9802913e640c7a5fb8f121531259587351e3193c397da3009R1-R29)
[[5]](diffhunk://#diff-37437b0987e4823f1569d0d59b2e58ba131cff16eb01972e84703ee24ee9cc62R1-R23)

### Configuration Updates:
* Changed `eslint.config.js` to use `eslint-config-bananass-react` and
updated ignored directories (`eslint.config.js`).
* Modified `package.json` to include the `website` workspace and added a
`dev` script for Docusaurus (`package.json`).
[[1]](diffhunk://#diff-7ae45ad102eab3b6d7e7896acd08c427a9b25b346470d7bc6507b6481575d519L12-R19)
[[2]](diffhunk://#diff-7ae45ad102eab3b6d7e7896acd08c427a9b25b346470d7bc6507b6481575d519L39-R41)

### Documentation Enhancements:
* Added new documentation files and categories for learning Docusaurus
(`website/docs/learn/`).
[[1]](diffhunk://#diff-51062d11edbc475a167534720d177cc9f0428578b1e814065272b943dcb814faR1-R47)
[[2]](diffhunk://#diff-23e6cb9474320269473f7981bc1f160344ab81f5b2ea81cfe254ec88aea9eba6R1-R8)
[[3]](diffhunk://#diff-dab155b07b5a18034e2b2795359b099b55806caa0095ecfcd8661b6ce7fa1a7cR1-R23)
[[4]](diffhunk://#diff-525c752ed506547ec3ef2a4d4cd85669163bbfcd13e195e272a18e478ca5671fR1-R34)
[[5]](diffhunk://#diff-1b2bcbd8002dcdd5858a9d0fb8444f83f8679ab1c7bc57c1a7b8c89321e56d5dR1-R57)
[[6]](diffhunk://#diff-405c2165f7be581c1a29ddb5776cf5d9c4eeaf5a8e12ca98ac7bcf23c3c0c63eR1-R43)

### Linting Configuration:
* Simplified `.markdownlint.json` by disabling `no-inline-html` and
`no-bare-urls` rules (`.markdownlint.json`).
  • Loading branch information
lumirlumir authored Jan 19, 2025
1 parent 02ca302 commit 298a4f0
Show file tree
Hide file tree
Showing 47 changed files with 26,612 additions and 8,475 deletions.
3 changes: 3 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ updates:
patterns:
- 'next'
- '@next/*'
docusaurus:
patterns:
- '@docusaurus/*'
reviewers:
- 'lumirlumir'
schedule:
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ node_modules
# production
build
.next
.docusaurus

# env
.env
Expand Down
19 changes: 2 additions & 17 deletions .markdownlint.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,8 @@
"ol-prefix": {
"style": "one"
},
"no-inline-html": {
"allowed_elements": [
"sub",
"sup",
"u",
"br",
"details",
"summary",
"image",
"code",
"kbd",
"mark",
"ruby",
"rp",
"rt"
]
},
"no-inline-html": false,
"no-bare-urls": false,
"hr-style": {
"style": "---"
},
Expand Down
1 change: 1 addition & 0 deletions .markdownlintignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ node_modules
# production
build
.next
.docusaurus

# files
LICENSE.md
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ node_modules
# production
build
.next
.docusaurus

# env
.env
Expand Down
4 changes: 2 additions & 2 deletions eslint.config.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
const bananass = require('eslint-config-bananass');
const bananass = require('eslint-config-bananass-react');

module.exports = [
{
ignores: ['**/build/', '**/coverage/'],
ignores: ['**/build/', '**/.next/', '**/.docusaurus/', '**/coverage/'],
},
bananass.configs.recommended,
];
Loading

0 comments on commit 298a4f0

Please sign in to comment.