Skip to content

Commit aaa7ed2

Browse files
WhyIsSandwichWhyIsSandwich
authored
Initial version of Wiki (#345)
* feat: Implement VitePress Markdown to Vue conversion with complete feature set - Added core markdown processing capabilities including standard markdown, HTML integration, and line breaks conversion. - Implemented front matter support with YAML parsing and metadata access. - Integrated syntax highlighting using Shiki with support for multiple languages and themes. - Developed markdown extensions and plugins for enhanced functionality, including header anchors, table of contents, emoji support, and custom containers. - Enabled Vue component integration with support for script and style blocks, Vue interpolation, and component usage. - Enhanced Vue features with support for directives, escaping Vue syntax, and CSS pre-processors. - Added advanced features such as math support, CJK-friendly support, image processing, and link processing. - Established a robust processing pipeline for converting markdown to Vue Single File Components (SFCs). - Ensured browser compatibility with CDN-based dependency management and Node.js polyfills. - Optimized performance with static content optimization and efficient client-side hydration. - Improved accessibility with ARIA labels and keyboard navigation support. - Comprehensive implementation of high, medium, and low priority features as outlined in the VitePress implementation todo list. * fix: Update deployment condition to trigger on 'wiki' branch instead of 'main' * fix: update references from SeaBlock-wiki to SeaBlock - Updated stylesheet and script paths in editor-iframe.html to point to the new SeaBlock directory. - Changed GitHub repository links in index.md and debug-original.md to reflect the new SeaBlock repository. - Adjusted base path in VitePressExtractedRenderer.js to align with the new directory structure. * Fix favicon.ico * Moved maintenance docs * Refactor documentation: Update SeaBlock reference materials, guides, and links - Revamped the reference index to focus on SeaBlock-specific terminology and abbreviations. - Updated links in debug-original.md to point to the correct GitHub repository. - Added comprehensive early game, mid game, and late game guides to assist players in their progression. - Enhanced clarity and organization of content for better user experience. * fix: update GitHub URL generation in copyToGitHub function for correct file paths * feat: enhance documentation with installation, first steps, notable items, recipes, and technologies sections * Create basic-markdown-guide.md * Create advanced-markdown-guide.md * fix: correct favicon path in VitePress config and enhance installation and reference documentation * fix: improve clarity in installation instructions for SeaBlock Pack * Add comprehensive documentation for Helmod Calculator including tutorials and hotkeys - Introduced a new markdown file for Helmod Calculator documentation. - Added beginner and intermediate video tutorials for user guidance. - Explained the process for handling circular recipes and recycling outputs. - Listed Helmod hotkeys to enhance user experience and efficiency. * Dynamic generation of sidebar content, additional content * Fixing links broken by changing paths
1 parent 66c2671 commit aaa7ed2

File tree

112 files changed

+17778
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

112 files changed

+17778
-0
lines changed

‎.devcontainer/devcontainer.json‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
{
2+
"name": "SeaBlock Wiki Development",
3+
"image": "mcr.microsoft.com/devcontainers/typescript-node:18",
4+
"features": {
5+
"ghcr.io/devcontainers/features/git:1": {},
6+
"ghcr.io/devcontainers/features/github-cli:1": {}
7+
},
8+
"customizations": {
9+
"vscode": {
10+
"extensions": [
11+
"vue.volar",
12+
"vue.vscode-typescript-vue-plugin",
13+
"bradlc.vscode-tailwindcss",
14+
"esbenp.prettier-vscode",
15+
"ms-vscode.vscode-json",
16+
"yzhang.markdown-all-in-one",
17+
"ms-vscode.vscode-markdown"
18+
],
19+
"settings": {
20+
"editor.formatOnSave": true,
21+
"editor.defaultFormatter": "esbenp.prettier-vscode",
22+
"typescript.preferences.importModuleSpecifier": "relative",
23+
"vue.codeActions.enabled": true,
24+
"vue.complete.casing.tags": "kebab",
25+
"vue.complete.casing.props": "camel"
26+
}
27+
}
28+
},
29+
"postCreateCommand": "bash .devcontainer/setup.sh",
30+
"forwardPorts": [5173, 3000],
31+
"portsAttributes": {
32+
"5173": {
33+
"label": "VitePress Dev Server",
34+
"onAutoForward": "notify"
35+
},
36+
"3000": {
37+
"label": "WYSIWYG Editor",
38+
"onAutoForward": "notify"
39+
}
40+
},
41+
"remoteUser": "node"
42+
}
43+

‎.devcontainer/setup.sh‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
#!/bin/bash
2+
3+
# SeaBlock Wiki Development Environment Setup
4+
echo "🚀 Setting up SeaBlock Wiki development environment..."
5+
6+
# Update npm to latest version
7+
npm install -g npm@latest
8+
9+
# Install VitePress globally for CLI access
10+
npm install -g vitepress@latest
11+
12+
# Install project dependencies
13+
echo "📦 Installing project dependencies..."
14+
npm install
15+
16+
# Create necessary directories
17+
echo "📁 Creating project structure..."
18+
mkdir -p content
19+
mkdir -p assets/js
20+
mkdir -p assets/css
21+
mkdir -p .github/workflows
22+
23+
# Set up git hooks (optional)
24+
echo "🔧 Setting up development tools..."
25+
26+
# Make scripts executable
27+
chmod +x dev.sh 2>/dev/null || true
28+
29+
echo "✅ Development environment setup complete!"
30+
echo ""
31+
echo "Next steps:"
32+
echo "1. Run 'npm run dev' to start the VitePress development server"
33+
echo "2. Run 'npm run build:browser' to build the browser bundle"
34+
echo "3. Run 'npm run dev:editor' to start the WYSIWYG editor"
35+
echo ""
36+
echo "Happy coding! 🎉"
37+

‎.eslintrc.js‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
module.exports = {
2+
root: true,
3+
env: {
4+
browser: true,
5+
es2021: true,
6+
node: true
7+
},
8+
extends: [
9+
'eslint:recommended',
10+
'@vue/eslint-config-typescript',
11+
'plugin:vue/vue3-recommended'
12+
],
13+
parserOptions: {
14+
ecmaVersion: 'latest',
15+
sourceType: 'module'
16+
},
17+
rules: {
18+
'vue/multi-word-component-names': 'off',
19+
'vue/no-v-html': 'off',
20+
'@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
21+
'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
22+
'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off'
23+
}
24+
}
25+

‎.github/workflows/deploy.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [wiki]
6+
pull_request:
7+
branches: [wiki]
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
jobs:
15+
build:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Checkout
19+
uses: actions/checkout@v4
20+
with:
21+
fetch-depth: 0
22+
23+
- name: Setup Node.js
24+
uses: actions/setup-node@v4
25+
with:
26+
node-version: '18'
27+
cache: 'npm'
28+
29+
- name: Install dependencies
30+
run: npm ci
31+
32+
- name: Build VitePress site
33+
run: npm run build
34+
35+
- name: Set up Pages
36+
id: pages
37+
uses: actions/configure-pages@v5
38+
39+
- name: Upload artifact
40+
uses: actions/upload-pages-artifact@v4
41+
with:
42+
path: ./docs/.vitepress/dist/
43+
44+
deploy:
45+
runs-on: ubuntu-latest
46+
needs: build
47+
if: github.ref == 'refs/heads/wiki'
48+
environment:
49+
name: github-pages
50+
url: ${{ steps.deployment.outputs.page_url }}
51+
steps:
52+
- name: Deploy to GitHub Pages
53+
id: deployment
54+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
# Dependencies
2+
node_modules/
3+
npm-debug.log*
4+
yarn-debug.log*
5+
yarn-error.log*
6+
7+
# Build outputs
8+
dist/
9+
.vitepress/dist/
10+
.vitepress/cache/
11+
12+
# VitePress build outputs
13+
docs/.vitepress/dist/
14+
docs/.vitepress/cache/
15+
16+
/assets/js/
17+
/assets/css/
18+
19+
# Test output files
20+
test/comparison-*.html
21+
test/live-comparison-report.json
22+
test/vitepress.html
23+
test/webbrowser.html
24+
25+
# Environment variables
26+
.env
27+
.env.local
28+
.env.development.local
29+
.env.test.local
30+
.env.production.local
31+
32+
# IDE and editor files
33+
.vscode/
34+
.idea/
35+
*.swp
36+
*.swo
37+
*~
38+
39+
# OS generated files
40+
.DS_Store
41+
.DS_Store?
42+
._*
43+
.Spotlight-V100
44+
.Trashes
45+
ehthumbs.db
46+
Thumbs.db
47+
48+
# Logs
49+
logs
50+
*.log
51+
52+
# Runtime data
53+
pids
54+
*.pid
55+
*.seed
56+
*.pid.lock
57+
58+
# Coverage directory used by tools like istanbul
59+
coverage/
60+
61+
# nyc test coverage
62+
.nyc_output
63+
64+
# Dependency directories
65+
jspm_packages/
66+
67+
# Optional npm cache directory
68+
.npm
69+
70+
# Optional REPL history
71+
.node_repl_history
72+
73+
# Output of 'npm pack'
74+
*.tgz
75+
76+
# Yarn Integrity file
77+
.yarn-integrity
78+
79+
# parcel-bundler cache (https://parceljs.org/)
80+
.cache
81+
.parcel-cache
82+
83+
# next.js build output
84+
.next
85+
86+
# nuxt.js build output
87+
.nuxt
88+
89+
# vuepress build output
90+
.vuepress/dist
91+
92+
# Serverless directories
93+
.serverless
94+
95+
# FuseBox cache
96+
.fusebox/
97+
98+
# DynamoDB Local files
99+
.dynamodb/
100+
101+
# TernJS port file
102+
.tern-port
103+
104+
# Stores VSCode versions used for testing VSCode extensions
105+
.vscode-test
106+
107+
# Temporary files
108+
*.tmp
109+
*.temp
110+
.tmp/
111+
.temp/
112+
113+
# Backup files
114+
*.bak
115+
*.backup
116+
*~
117+
118+
# Lock files (keep package-lock.json but ignore others)
119+
yarn.lock
120+
pnpm-lock.yaml
121+
122+
# TypeScript build info
123+
*.tsbuildinfo
124+
125+
# ESLint cache
126+
.eslintcache
127+
128+
# Prettier cache
129+
.prettiercache
130+
131+
# Vite cache
132+
.vite/
133+
134+
# Local development files
135+
.local/
136+
local/
137+
138+
# Documentation build artifacts
139+
docs/build/
140+
docs/.vitepress/temp/
141+
142+
# Editor temporary files
143+
*.sublime-*
144+
*.code-workspace
145+

‎.prettierrc‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"semi": false,
3+
"singleQuote": true,
4+
"tabWidth": 2,
5+
"trailingComma": "none",
6+
"printWidth": 100,
7+
"endOfLine": "lf",
8+
"arrowParens": "avoid",
9+
"bracketSpacing": true,
10+
"bracketSameLine": false,
11+
"vueIndentScriptAndStyle": false
12+
}
13+

‎LICENSE.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# SeaBlock Documentation Image Licensing
2+
3+
This project includes images sourced from the SeaBlock Fandom Wiki and Reddit, used in accordance with their respective licenses:
4+
5+
## SeaBlock Fandom Wiki Images
6+
7+
All images downloaded from the SeaBlock Fandom Wiki (https://seablock.fandom.com/) are licensed under the Creative Commons Attribution-ShareAlike (CC-BY-SA) license, unless otherwise noted. See: https://www.fandom.com/licensing
8+
9+
## Reddit Images
10+
11+
Images and charts sourced from Reddit posts by u/DanielKotes and others are used with attribution to the original authors. Where possible, original links and credits are provided in the documentation.
12+
13+
## Attribution
14+
15+
- SeaBlock Fandom Wiki: CC-BY-SA, https://seablock.fandom.com/
16+
- Reddit: Original authors credited in guide sections
17+
18+
If you use or redistribute these images, you must comply with the terms of the CC-BY-SA license and provide appropriate attribution.
19+
20+
---
21+
22+
For questions or requests regarding image licensing, please contact the maintainers or refer to the original sources.

0 commit comments

Comments
 (0)