Publish docs alongside app

This commit is contained in:
Austen Adler 2023-03-12 01:38:17 -05:00
parent e543140022
commit b55a1c7afb
8 changed files with 22 additions and 24 deletions

View File

@ -12,7 +12,7 @@
The goal of this document is to define the algorithm.
If you want to see the steps to get to this definition, go to link:/docs/DESIGN[DESIGN].
If you want to see the steps to get to this definition, go to link:/docs/DESIGN.html[DESIGN].
== Data format

View File

@ -12,7 +12,7 @@
The goal of this document is to walk through how the design was chosen.
If you want to see the algorithm definition, go to link:/docs/ALGORITHM[ALGORITHM].
If you want to see the algorithm definition, go to link:/docs/ALGORITHM.html[ALGORITHM].
== 10,000 meter view

View File

@ -10,10 +10,9 @@
== Pages
* link:..[xpin.app] - Go back to the xpin homepage
* link:/docs/ALGORITHM[ALGORITHM] - Algorithm definition
* link:/docs/DESIGN[DESIGN] - Algorithm design documentation
* link:/docs/WORDLIST[WORDLIST] - Wordlist design and implementation
* link:/docs/ALGORITHM.html[ALGORITHM] - Algorithm definition
* link:/docs/DESIGN.html[DESIGN] - Algorithm design documentation
* link:/docs/WORDLIST.html[WORDLIST] - Wordlist design and implementation
++++
<style>

View File

@ -16,13 +16,14 @@ wasm-build:
wordlist-build:
. wordlist/venv/bin/activate && cd wordlist && for i in *.py; do "./${i}"; done
js-build: wasm-build docs-build
js-build: output-clean wasm-build docs-build
rsync -ha ./build/docs/ ./web-frontend/static/docs/
yarn --cwd ./web-frontend/ build
rsync -ha ./web-frontend/build/ ./build/
output-clean:
rm -vrf build
mkdir build
rm -vrf ./build/ ./web-frontend/build/
mkdir ./build/
docs-build: output-clean
earthly +docs

View File

@ -1,10 +1,11 @@
.DS_Store
node_modules
/build
/.svelte-kit
/package
.DS_Store
.env
.env.*
!.env.example
node_modules
/package
/static/docs/
/.svelte-kit
vite.config.js.timestamp-*
vite.config.ts.timestamp-*

View File

@ -8,8 +8,8 @@
"preview": "vite preview",
"check": "svelte-kit sync && svelte-check --tsconfig ./jsconfig.json",
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./jsconfig.json --watch",
"lint": "prettier --plugin-search-dir . --check . && eslint .",
"format": "prettier --plugin-search-dir . --write ."
"lint": "prettier --plugin-search-dir . --check src && eslint .",
"format": "prettier --plugin-search-dir . --write src"
},
"devDependencies": {
"@sveltejs/adapter-auto": "^2.0.0",

View File

@ -23,22 +23,18 @@
/></svg
>-->
<a href="/">
<span class="font-semibold text-xl tracking-tight">Xpin</span>
<span class="font-semibold text-xl tracking-tight">xpin</span>
</a>
</div>
<div class="block">
<div class="text-sm">
<a href="/" class="block inline-block text-white hover:text-gray-500 mr-4 p-2">Home</a>
<a
href="/docs/"
rel="external"
href="/docs"
class="block inline-block text-white hover:text-gray-500 mr-4 p-2"
data-sveltekit-reload>Docs</a
>
Docs
</a>
<a href="/app" class="block inline-block text-white hover:text-gray-500 mr-4 p-2">
App
</a>
<a href="/app" class="block inline-block text-white hover:text-gray-500 mr-4 p-2">App</a>
</div>
</div>
</nav>

View File

@ -0,0 +1 @@
<iframe src="/docs/index.html" class="h-full w-full" />