https://github.com/server-state/specs
Specifications for the server-state project's core aspects
https://github.com/server-state/specs
api-documentation assets branding documentation server-state specifications terminology
Last synced: 4 months ago
JSON representation
Specifications for the server-state project's core aspects
- Host: GitHub
- URL: https://github.com/server-state/specs
- Owner: server-state
- License: mit
- Created: 2019-09-05T09:00:30.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-20T09:23:47.000Z (about 6 years ago)
- Last Synced: 2025-06-16T02:39:38.832Z (12 months ago)
- Topics: api-documentation, assets, branding, documentation, server-state, specifications, terminology
- Language: HTML
- Homepage: https://specs.server-state.tech
- Size: 420 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# specs
Specifications for the server-state project's core aspects
**Please note** that this repo contains specifications for the core modules of the project, i.e., primarily [server-base](https://github.com/server-state/server-base) and [client-base](https://github.com/server-state/client-base). Specifications specific to modules (e.g., grammars for [linux-raid-module](https://github.com/server-state/linux-raid-module) will exist in the specific module's repository.
### Languages and formats
Supported document formats for this repo are
- PNG, SVG, GIF, JPG
- LaTeX (with compiled PDF alongside it)
- Markdown (`.md`)
While other formats are acceptable, you should not use them when not necessary.
#### Special supported Markdown Syntax
As the main deployment of these docs gets built with docsify (and some plugins, cf. `index.html`), we support special Markdown features such as callouts, LaTeX and PlantUML. You can find a list of them below.
##### LaTeX
```markdown
$O(n)$
$$O(n)$$
```
results in
$O(n)$
$$O(n)$$
##### Emoji
```markdown
:wink: :smile: :tada:
```
results in
:wink: :smile: :tada:
##### PlantUML
````markdown
```plantuml
@startuml
Alice->Alex: Hello world
Alice<--Alex: Hello, Alice!
@enduml
```
````
results in
```plantuml
@startuml
Alice->Alex: Hello world
Alice<--Alex: Hello, Alice!
@enduml
```
##### Callouts
```markdown
> [!NOTE]
> A note
> [!TIP]
> A little secret tip: Stay calm.
> [!WARNING]
> A warning
> [!DANGER]
> A critical warning
```
results in
> [!NOTE]
> A note
> [!TIP]
> A little secret tip: Stay calm.
> [!WARNING]
> A warning
> [!DANGER]
> A critical warning