Table of contents

• Description
• Markdown Documentation
• Writting Conventions

Description

Contains scripts and notes on various software (games, tools, linux, ...).
Serves as a back-up and centralization for all my tuning/tweaking needs.

Markdown Documentation

I don't know where to put this, so here it is.

Highlighting box

Highlights a text by framing it in an element with an icon.
Useful for writing a Wiki.
This was inspired by some cool documentation, like Spring Boot.

ℹ️ Note
Add details or a context to something

✅ Tips
Add another way of doing things or give details on how to use.
This box can be expanded with several lines.

👉 Important
Extra warning to prevent major issues

⚠️ Warning
Warns or prevent potential consequences

⛔️ Caution
Indicate that something is impossible or not advised

To add this box, you can use this notation :

              current page
add anchor ─────┐  │    ┌──────  tooltip
            > [ℹ️](# "Info")
            > Text here

Highlight in GitHub

Note

Useful information that users should know, even when skimming content.

Tip

Helpful advice for doing things better or more easily.

Important

Key information users need to know to achieve their goal.

Warning

Urgent info that needs immediate user attention to avoid problems.

Caution

Advises about risks or negative outcomes of certain actions.

Writting Conventions

Command/code synopsis

Description

Convention used to describe command usage or code snippets.
Usefull for text friendly manual or usage tips in documentations.

Usage	Manual (Unix)	PostgreSQL	regex
used for as-is text	bold format (no format in cli)	no format
indicate replaceable arguments	italic format (underlined uppercase in cli)	italic and bold	\w+
choices delimiter	not supported (braces {} in GNU style)	braces {}	()
choices separator	vertical bars |	vertical bars |	|
surround optional parts or arguments	brackets []	brackets []	()?
the preceding element can be repeated	ellipses ...	ellipses ...	( \g<-2>)*

All other symbols, including parentheses, should be taken literally

Exemple

ftp [-pinegvd] [host]
ftp (-[pinegvd]+)?( \g<-2>)* [a-zA-Z0-9_.]+

• ftp -p sample.host
• ftp -i other.host

GRANT { { CREATE | CONNECT | TEMPORARY | TEMP } [, ...] | ALL [ PRIVILEGES ] } ON DATABASE database_name [, ...] TO role_specification [, ...] [ WITH GRANT OPTION ][ GRANTED BY role_specification ]
GRANT (((CREATE|CONNECT|TEMPORARY|TEMP)(,\g<2>)*)|(ALL( PRIVILEGES)?)) ON DATABASE (\w+)(,\g<-2>)* TO (\w+)(,\g<-2>)*( WITH GRANT OPTION)?( GRANTED BY (\w+)(,\g<-2>)*)?

• GRANT CREATE, CONNECT ON DATABASE db-sample TO db-user
• GRANT ALL ON DATABASE db-sample TO db-user