stonewareslord/this_algorithm
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Publish docs alongside app

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/ALGORITHM.adoc
View File

@ -12,7 +12,7 @@
The goal of this document is to define the algorithm. 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 == Data format

2
docs/DESIGN.adoc
View File

@ -12,7 +12,7 @@
The goal of this document is to walk through how the design was chosen. 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 == 10,000 meter view

7
docs/index.adoc
View File

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

7
justfile
View File

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

9
web-frontend/.gitignore vendored
View File

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

4
web-frontend/package.json
View File

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

12
web-frontend/src/routes/+layout.svelte
View File

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

1
web-frontend/src/routes/docs/+page.svelte Normal file
View File

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