Skip to content

glauth/glauth.github.io

Repository files navigation

What is this?

This is a temporary website so that curious folks have something to look at.

Followed a few "startup marketing" principles.

Still quite bare but I don't think either of us would like to add fluff for no reason.

Documentation

This website now also offers a documentation area.

A quick note regarding yarn. If it is not installed globally, you can install locally it using npm install yarn and adding node_modules/yarn/bin to your PATH.

While authoring the documentation, one can keep checking their work using:

cd spacebook && yarn watch

To build a proper preview, including syntax highlighting:

cd spacebook && yarn build

From the top-level folder, build the documentation as it will be published:

yarn doc

Of course, to build the whole site, we need to ensure that the stylesheet is up-to-date:

yarn dev
yarn prod

Note: yarn <xxx> is equivalent to npm run <xxx>

OK, so... step by step?

cd spacebook
brew install vips # mac only
yarn install
cd ..
npm i run-p
yarn sync
cd spacebook
yarn build

Database diagram created using dbdiagram.io

See .txt files in content/images/

Markdown

[[toc]]

::: wanrning blah :::


Here is a footnote reference,1 and another.2


<-Centered text->


Labels:

#important


## Updating

git pull yarn sync # auto refresh yarn doc # refresh doc pages yarn prod # and assets

LOOKs LIKE THIS SHOULD BE DEPRECATED AND NOW WORKS OUT OF THE BOX: cp docs/docs/index-search.json docs/ # update search content

git push

Footnotes

  1. Here is the footnote.

  2. Here's one with multiple blocks.

    Subsequent paragraphs are indented to show that they belong to the previous footnote.

About

GH Pages for glauth - not yet ready

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •