Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/glauth/glauth.github.io
GH Pages for glauth - not yet ready
https://github.com/glauth/glauth.github.io
Last synced: about 2 months ago
JSON representation
GH Pages for glauth - not yet ready
- Host: GitHub
- URL: https://github.com/glauth/glauth.github.io
- Owner: glauth
- Created: 2018-05-24T18:11:54.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-26T01:42:27.000Z (about 1 year ago)
- Last Synced: 2023-12-26T02:27:14.477Z (almost 1 year ago)
- Language: HTML
- Homepage:
- Size: 20.8 MB
- Stars: 1
- Watchers: 5
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.html
- Security: docs/security.html
Awesome Lists containing this project
README
## 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 ` is equivalent to `npm run `
## 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.[^longnote]
[^1]: Here is the footnote.
[^longnote]: Here's one with multiple blocks.
Subsequent paragraphs are indented to show that they
belong to the previous footnote.
```
```
<-Centered text->
```
Labels:
```
#[important](red)
```
## 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
```