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

feat: move from vuepress to docusaurus #53

Merged
merged 6 commits into from
Jul 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 15 additions & 69 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,74 +1,20 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# nyc test coverage
.nyc_output

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release
# Dependencies
/node_modules

# Dependency directories
node_modules/
jspm_packages/
# Production
/build

# Typescript v1 declaration files
typings/
# Generated files
.docusaurus
.cache-loader

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# dotenv environment variables file
.env

# gatsby files
.cache/
/public

# Mac files
# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

# Yarn
yarn-error.log
.pnp/
.pnp.js
# Yarn Integrity file
.yarn-integrity

static/documentation/

# VSCode files
.vscode/
npm-debug.log*
yarn-debug.log*
yarn-error.log*
1 change: 1 addition & 0 deletions .node-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
20
3 changes: 3 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
27 changes: 27 additions & 0 deletions biome.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"$schema": "https://biomejs.dev/schemas/1.7.3/schema.json",
"formatter": {
"enabled": true,
"formatWithErrors": false,
"indentStyle": "space",
"indentWidth": 2,
"lineEnding": "lf",
"lineWidth": 100,
"attributePosition": "auto"
},
"organizeImports": { "enabled": true },
"linter": { "enabled": true, "rules": { "recommended": true } },
"javascript": {
"formatter": {
"jsxQuoteStyle": "double",
"quoteProperties": "asNeeded",
"trailingComma": "es5",
"semicolons": "always",
"arrowParentheses": "always",
"bracketSpacing": true,
"bracketSameLine": false,
"quoteStyle": "single",
"attributePosition": "auto"
}
}
}
32 changes: 32 additions & 0 deletions blog/2024-07-30-docs-revamp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
slug: docs-revamp
title: Documentation Revamp
authors: [diogotcorreia]
tags: [misc]
---

Welcome to the redesigned documentation and website for Triton!

Along with a fresh new coat of paint, this redesign brings a new blog section
to Triton's website, which will contain major release notes (e.g. for the upcoming v4 release),
development journals, and more.

With regards to the content itself, nothing has changed significantly.
There were, however, some corrections made to outdated content.

Since most URLs have changed from the previous website, redirects were put in place
to ensure old links keep working.

## Why now?

The previous website used [VuePress 1](https://v1.vuepress.vuejs.org/) which is
severely outdated and still requires Python 2 (which has been end of life since 2013).
This made it impractical to edit documentation, since it would require installing and
running unmaintained and insecure software.
While [VuePress 2](https://v2.vuepress.vuejs.org/) would fix most of these issues, at the
time of writing there is no stable release yet (currently at v2.0.0-rc.14).

For this reason, the website has been migrated to [Docusaurus](https://docusaurus.io/), a
React-based documentation framework built by Meta (previously Facebook).
Docusaurus has tons of features, and completely fulfills the website's needs while allowing
for future customization.
5 changes: 5 additions & 0 deletions blog/authors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
diogotcorreia:
name: Diogo Correia
title: Creator and Developer of TritonMC
url: https://github.com/diogotcorreia
image_url: https://github.com/diogotcorreia.png
4 changes: 4 additions & 0 deletions blog/tags.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
misc:
label: Misc
permalink: /misc
description: Miscellaneous posts
201 changes: 0 additions & 201 deletions docs/.vuepress/config.js

This file was deleted.

14 changes: 0 additions & 14 deletions docs/.vuepress/public/_redirects

This file was deleted.

Loading