Update README.md
This commit is contained in:
parent
33466ce020
commit
a3d011ed0f
691
README.md
691
README.md
|
|
@ -1,2 +1,693 @@
|
|||
# .portfolio
|
||||
|
||||
> [!IMPORTANT]
|
||||
>
|
||||
> Various unrelated examples.
|
||||
|
||||
# Serveur de portfolio de [coh@bit](https://cohabit.fr)
|
||||
|
||||
Sert les portfofolio (site static) depuis la branche `main` de
|
||||
`https://git.cohabit.fr/[user]/.portfolio/`.
|
||||
|
||||
> [!NOTE]
|
||||
>
|
||||
> La racine par default est `'/dist'` et la page par default `/dist/index.html`
|
||||
> (mode power user).
|
||||
>
|
||||
> Si `/dist/index.html` n'existe pas la racine devient `'/'` et la page par
|
||||
> defaut `/README.md` (mode
|
||||
> [WYSIWYG](https://fr.wikipedia.org/wiki/What_you_see_is_what_you_get) user).
|
||||
|
||||
Une rediection html peut être utilisée pour "changer la racine" ou rediriger
|
||||
vers un site externe.
|
||||
|
||||
```html
|
||||
<meta http-equiv="refresh" content="0;URL=${destination}" />
|
||||
```
|
||||
|
||||
> [!IMPORTANT]
|
||||
>
|
||||
> Chaque utilisateur (cohabit) se voit attribuer le sous domaine
|
||||
> `https://[user_subdomain].portfolio.cohabit.fr`.
|
||||
>
|
||||
> Chaque portfolio et donc isolé et ne (peut) partager aucune information
|
||||
> (cookie, scripts, xss, ...) avec les autres portfolios et domaines de
|
||||
> [cohabit](https://cohabit.fr).
|
||||
|
||||
Formats :
|
||||
|
||||
- `user` : `${firstname}.${lastname}`
|
||||
- `user_subdomain` : `${firstname}-${lastname}`
|
||||
|
||||
## Usage
|
||||
|
||||
1. Cloner le repo.
|
||||
1. Lancer le serveur.
|
||||
- Executer `deno task start` //Serveur sur le port 8000 par default.
|
||||
- Ou, executer `PORT=7000 deno task start` //Spécifier le port d'écoute
|
||||
désiré.
|
||||
- Ou, utiliser le service définit dans
|
||||
`cohabit/server_config/portfolio_server`.
|
||||
|
||||
## Contribution
|
||||
|
||||
1. Install [deno](https://deno.land).
|
||||
1. Follow
|
||||
[deno convention](https://docs.deno.com/runtime/manual/references/contributing/style_guide).
|
||||
1. Follow
|
||||
[conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).
|
||||
1. Follow [sermver](https://semver.org/lang/fr/).
|
||||
1. Run and check `deno task check` before any commit.
|
||||
|
||||
|
||||
# Headers
|
||||
|
||||
```
|
||||
# h1 Heading 8-)
|
||||
## h2 Heading
|
||||
### h3 Heading
|
||||
#### h4 Heading
|
||||
##### h5 Heading
|
||||
###### h6 Heading
|
||||
|
||||
Alternatively, for H1 and H2, an underline-ish style:
|
||||
|
||||
Alt-H1
|
||||
======
|
||||
|
||||
Alt-H2
|
||||
------
|
||||
```
|
||||
|
||||
# h1 Heading 8-)
|
||||
## h2 Heading
|
||||
### h3 Heading
|
||||
#### h4 Heading
|
||||
##### h5 Heading
|
||||
###### h6 Heading
|
||||
|
||||
Alternatively, for H1 and H2, an underline-ish style:
|
||||
|
||||
Alt-H1
|
||||
======
|
||||
|
||||
Alt-H2
|
||||
------
|
||||
|
||||
------
|
||||
|
||||
# Emphasis
|
||||
|
||||
```
|
||||
Emphasis, aka italics, with *asterisks* or _underscores_.
|
||||
|
||||
Strong emphasis, aka bold, with **asterisks** or __underscores__.
|
||||
|
||||
Combined emphasis with **asterisks and _underscores_**.
|
||||
|
||||
Strikethrough uses two tildes. ~~Scratch this.~~
|
||||
|
||||
**This is bold text**
|
||||
|
||||
__This is bold text__
|
||||
|
||||
*This is italic text*
|
||||
|
||||
_This is italic text_
|
||||
|
||||
~~Strikethrough~~
|
||||
```
|
||||
|
||||
Emphasis, aka italics, with *asterisks* or _underscores_.
|
||||
|
||||
Strong emphasis, aka bold, with **asterisks** or __underscores__.
|
||||
|
||||
Combined emphasis with **asterisks and _underscores_**.
|
||||
|
||||
Strikethrough uses two tildes. ~~Scratch this.~~
|
||||
|
||||
**This is bold text**
|
||||
|
||||
__This is bold text__
|
||||
|
||||
*This is italic text*
|
||||
|
||||
_This is italic text_
|
||||
|
||||
~~Strikethrough~~
|
||||
|
||||
------
|
||||
|
||||
# Lists
|
||||
|
||||
```
|
||||
1. First ordered list item
|
||||
2. Another item
|
||||
⋅⋅* Unordered sub-list.
|
||||
1. Actual numbers don't matter, just that it's a number
|
||||
⋅⋅1. Ordered sub-list
|
||||
4. And another item.
|
||||
|
||||
⋅⋅⋅You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
|
||||
|
||||
⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅
|
||||
⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅
|
||||
⋅⋅⋅(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
|
||||
|
||||
* Unordered list can use asterisks
|
||||
- Or minuses
|
||||
+ Or pluses
|
||||
|
||||
1. Make my changes
|
||||
1. Fix bug
|
||||
2. Improve formatting
|
||||
- Make the headings bigger
|
||||
2. Push my commits to GitHub
|
||||
3. Open a pull request
|
||||
* Describe my changes
|
||||
* Mention all the members of my team
|
||||
* Ask for feedback
|
||||
|
||||
+ Create a list by starting a line with `+`, `-`, or `*`
|
||||
+ Sub-lists are made by indenting 2 spaces:
|
||||
- Marker character change forces new list start:
|
||||
* Ac tristique libero volutpat at
|
||||
+ Facilisis in pretium nisl aliquet
|
||||
- Nulla volutpat aliquam velit
|
||||
+ Very easy!
|
||||
```
|
||||
|
||||
1. First ordered list item
|
||||
2. Another item
|
||||
⋅⋅* Unordered sub-list.
|
||||
1. Actual numbers don't matter, just that it's a number
|
||||
⋅⋅1. Ordered sub-list
|
||||
4. And another item.
|
||||
|
||||
⋅⋅⋅You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
|
||||
|
||||
⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅
|
||||
⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅
|
||||
⋅⋅⋅(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
|
||||
|
||||
* Unordered list can use asterisks
|
||||
- Or minuses
|
||||
+ Or pluses
|
||||
|
||||
1. Make my changes
|
||||
1. Fix bug
|
||||
2. Improve formatting
|
||||
- Make the headings bigger
|
||||
2. Push my commits to GitHub
|
||||
3. Open a pull request
|
||||
* Describe my changes
|
||||
* Mention all the members of my team
|
||||
* Ask for feedback
|
||||
|
||||
+ Create a list by starting a line with `+`, `-`, or `*`
|
||||
+ Sub-lists are made by indenting 2 spaces:
|
||||
- Marker character change forces new list start:
|
||||
* Ac tristique libero volutpat at
|
||||
+ Facilisis in pretium nisl aliquet
|
||||
- Nulla volutpat aliquam velit
|
||||
+ Very easy!
|
||||
|
||||
------
|
||||
|
||||
# Task lists
|
||||
|
||||
```
|
||||
- [x] Finish my changes
|
||||
- [ ] Push my commits to GitHub
|
||||
- [ ] Open a pull request
|
||||
- [x] @mentions, #refs, [links](), **formatting**, and <del>tags</del> supported
|
||||
- [x] list syntax required (any unordered or ordered list supported)
|
||||
- [x] this is a complete item
|
||||
- [ ] this is an incomplete item
|
||||
```
|
||||
|
||||
- [x] Finish my changes
|
||||
- [ ] Push my commits to GitHub
|
||||
- [ ] Open a pull request
|
||||
- [x] @mentions, #refs, [links](), **formatting**, and <del>tags</del> supported
|
||||
- [x] list syntax required (any unordered or ordered list supported)
|
||||
- [ ] this is a complete item
|
||||
- [ ] this is an incomplete item
|
||||
|
||||
------
|
||||
|
||||
# Ignoring Markdown formatting
|
||||
|
||||
You can tell GitHub to ignore (or escape) Markdown formatting by using \ before the Markdown character.
|
||||
|
||||
```
|
||||
Let's rename \*our-new-project\* to \*our-old-project\*.
|
||||
```
|
||||
|
||||
Let's rename \*our-new-project\* to \*our-old-project\*.
|
||||
|
||||
------
|
||||
|
||||
# Links
|
||||
|
||||
```
|
||||
[I'm an inline-style link](https://www.google.com)
|
||||
|
||||
[I'm an inline-style link with title](https://www.google.com "Google's Homepage")
|
||||
|
||||
[I'm a reference-style link][Arbitrary case-insensitive reference text]
|
||||
|
||||
[I'm a relative reference to a repository file](../blob/master/LICENSE)
|
||||
|
||||
[You can use numbers for reference-style link definitions][1]
|
||||
|
||||
Or leave it empty and use the [link text itself].
|
||||
|
||||
URLs and URLs in angle brackets will automatically get turned into links.
|
||||
http://www.example.com or <http://www.example.com> and sometimes
|
||||
example.com (but not on Github, for example).
|
||||
|
||||
Some text to show that the reference links can follow later.
|
||||
|
||||
[arbitrary case-insensitive reference text]: https://www.mozilla.org
|
||||
[1]: http://slashdot.org
|
||||
[link text itself]: http://www.reddit.com
|
||||
```
|
||||
|
||||
[I'm an inline-style link](https://www.google.com)
|
||||
|
||||
[I'm an inline-style link with title](https://www.google.com "Google's Homepage")
|
||||
|
||||
[I'm a reference-style link][Arbitrary case-insensitive reference text]
|
||||
|
||||
[I'm a relative reference to a repository file](../blob/master/LICENSE)
|
||||
|
||||
[You can use numbers for reference-style link definitions][1]
|
||||
|
||||
Or leave it empty and use the [link text itself].
|
||||
|
||||
URLs and URLs in angle brackets will automatically get turned into links.
|
||||
http://www.example.com or <http://www.example.com> and sometimes
|
||||
example.com (but not on Github, for example).
|
||||
|
||||
Some text to show that the reference links can follow later.
|
||||
|
||||
[arbitrary case-insensitive reference text]: https://www.mozilla.org
|
||||
[1]: http://slashdot.org
|
||||
[link text itself]: http://www.reddit.com
|
||||
|
||||
------
|
||||
|
||||
# Images
|
||||
|
||||
```
|
||||
Here's our logo (hover to see the title text):
|
||||
|
||||
Inline-style:
|
||||
|
||||
|
||||
Reference-style:
|
||||
![alt text][logo]
|
||||
|
||||
[logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Logo Title Text 2"
|
||||
|
||||
|
||||
|
||||
|
||||
Like links, Images also have a footnote style syntax
|
||||
|
||||
![Alt text][id]
|
||||
|
||||
With a reference later in the document defining the URL location:
|
||||
|
||||
[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"
|
||||
```
|
||||
|
||||
Here's our logo (hover to see the title text):
|
||||
|
||||
Inline-style:
|
||||
|
||||
|
||||
Reference-style:
|
||||
![alt text][logo]
|
||||
|
||||
[logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Logo Title Text 2"
|
||||
|
||||
|
||||
|
||||
|
||||
Like links, Images also have a footnote style syntax
|
||||
|
||||
![Alt text][id]
|
||||
|
||||
With a reference later in the document defining the URL location:
|
||||
|
||||
[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"
|
||||
|
||||
------
|
||||
|
||||
# [Footnotes](https://github.com/markdown-it/markdown-it-footnote)
|
||||
|
||||
```
|
||||
Footnote 1 link[^first].
|
||||
|
||||
Footnote 2 link[^second].
|
||||
|
||||
Inline footnote^[Text of inline footnote] definition.
|
||||
|
||||
Duplicated footnote reference[^second].
|
||||
|
||||
[^first]: Footnote **can have markup**
|
||||
|
||||
and multiple paragraphs.
|
||||
|
||||
[^second]: Footnote text.
|
||||
```
|
||||
|
||||
Footnote 1 link[^first].
|
||||
|
||||
Footnote 2 link[^second].
|
||||
|
||||
Inline footnote^[Text of inline footnote] definition.
|
||||
|
||||
Duplicated footnote reference[^second].
|
||||
|
||||
[^first]: Footnote **can have markup**
|
||||
|
||||
and multiple paragraphs.
|
||||
|
||||
[^second]: Footnote text.
|
||||
|
||||
------
|
||||
|
||||
# Code and Syntax Highlighting
|
||||
|
||||
```
|
||||
Inline `code` has `back-ticks around` it.
|
||||
```
|
||||
|
||||
Inline `code` has `back-ticks around` it.
|
||||
|
||||
```c#
|
||||
using System.IO.Compression;
|
||||
|
||||
#pragma warning disable 414, 3021
|
||||
|
||||
namespace MyApplication
|
||||
{
|
||||
[Obsolete("...")]
|
||||
class Program : IInterface
|
||||
{
|
||||
public static List<int> JustDoIt(int count)
|
||||
{
|
||||
Console.WriteLine($"Hello {Name}!");
|
||||
return new List<int>(new int[] { 1, 2, 3 })
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
```css
|
||||
@font-face {
|
||||
font-family: Chunkfive; src: url('Chunkfive.otf');
|
||||
}
|
||||
|
||||
body, .usertext {
|
||||
color: #F0F0F0; background: #600;
|
||||
font-family: Chunkfive, sans;
|
||||
}
|
||||
|
||||
@import url(print.css);
|
||||
@media print {
|
||||
a[href^=http]::after {
|
||||
content: attr(href)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
```javascript
|
||||
function $initHighlight(block, cls) {
|
||||
try {
|
||||
if (cls.search(/\bno\-highlight\b/) != -1)
|
||||
return process(block, true, 0x0F) +
|
||||
` class="${cls}"`;
|
||||
} catch (e) {
|
||||
/* handle exception */
|
||||
}
|
||||
for (var i = 0 / 2; i < classes.length; i++) {
|
||||
if (checkCondition(classes[i]) === undefined)
|
||||
console.log('undefined');
|
||||
}
|
||||
}
|
||||
|
||||
export $initHighlight;
|
||||
```
|
||||
|
||||
```php
|
||||
require_once 'Zend/Uri/Http.php';
|
||||
|
||||
namespace Location\Web;
|
||||
|
||||
interface Factory
|
||||
{
|
||||
static function _factory();
|
||||
}
|
||||
|
||||
abstract class URI extends BaseURI implements Factory
|
||||
{
|
||||
abstract function test();
|
||||
|
||||
public static $st1 = 1;
|
||||
const ME = "Yo";
|
||||
var $list = NULL;
|
||||
private $var;
|
||||
|
||||
/**
|
||||
* Returns a URI
|
||||
*
|
||||
* @return URI
|
||||
*/
|
||||
static public function _factory($stats = array(), $uri = 'http')
|
||||
{
|
||||
echo __METHOD__;
|
||||
$uri = explode(':', $uri, 0b10);
|
||||
$schemeSpecific = isset($uri[1]) ? $uri[1] : '';
|
||||
$desc = 'Multi
|
||||
line description';
|
||||
|
||||
// Security check
|
||||
if (!ctype_alnum($scheme)) {
|
||||
throw new Zend_Uri_Exception('Illegal scheme');
|
||||
}
|
||||
|
||||
$this->var = 0 - self::$st;
|
||||
$this->list = list(Array("1"=> 2, 2=>self::ME, 3 => \Location\Web\URI::class));
|
||||
|
||||
return [
|
||||
'uri' => $uri,
|
||||
'value' => null,
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
echo URI::ME . URI::$st1;
|
||||
|
||||
__halt_compiler () ; datahere
|
||||
datahere
|
||||
datahere */
|
||||
datahere
|
||||
```
|
||||
|
||||
------
|
||||
|
||||
# Tables
|
||||
|
||||
```
|
||||
Colons can be used to align columns.
|
||||
|
||||
| Tables | Are | Cool |
|
||||
| ------------- |:-------------:| -----:|
|
||||
| col 3 is | right-aligned | $1600 |
|
||||
| col 2 is | centered | $12 |
|
||||
| zebra stripes | are neat | $1 |
|
||||
|
||||
There must be at least 3 dashes separating each header cell.
|
||||
The outer pipes (|) are optional, and you don't need to make the
|
||||
raw Markdown line up prettily. You can also use inline Markdown.
|
||||
|
||||
Markdown | Less | Pretty
|
||||
--- | --- | ---
|
||||
*Still* | `renders` | **nicely**
|
||||
1 | 2 | 3
|
||||
|
||||
| First Header | Second Header |
|
||||
| ------------- | ------------- |
|
||||
| Content Cell | Content Cell |
|
||||
| Content Cell | Content Cell |
|
||||
|
||||
| Command | Description |
|
||||
| --- | --- |
|
||||
| git status | List all new or modified files |
|
||||
| git diff | Show file differences that haven't been staged |
|
||||
|
||||
| Command | Description |
|
||||
| --- | --- |
|
||||
| `git status` | List all *new or modified* files |
|
||||
| `git diff` | Show file differences that **haven't been** staged |
|
||||
|
||||
| Left-aligned | Center-aligned | Right-aligned |
|
||||
| :--- | :---: | ---: |
|
||||
| git status | git status | git status |
|
||||
| git diff | git diff | git diff |
|
||||
|
||||
| Name | Character |
|
||||
| --- | --- |
|
||||
| Backtick | ` |
|
||||
| Pipe | \| |
|
||||
```
|
||||
|
||||
Colons can be used to align columns.
|
||||
|
||||
| Tables | Are | Cool |
|
||||
| ------------- |:-------------:| -----:|
|
||||
| col 3 is | right-aligned | $1600 |
|
||||
| col 2 is | centered | $12 |
|
||||
| zebra stripes | are neat | $1 |
|
||||
|
||||
There must be at least 3 dashes separating each header cell.
|
||||
The outer pipes (|) are optional, and you don't need to make the
|
||||
raw Markdown line up prettily. You can also use inline Markdown.
|
||||
|
||||
Markdown | Less | Pretty
|
||||
--- | --- | ---
|
||||
*Still* | `renders` | **nicely**
|
||||
1 | 2 | 3
|
||||
|
||||
| First Header | Second Header |
|
||||
| ------------- | ------------- |
|
||||
| Content Cell | Content Cell |
|
||||
| Content Cell | Content Cell |
|
||||
|
||||
| Command | Description |
|
||||
| --- | --- |
|
||||
| git status | List all new or modified files |
|
||||
| git diff | Show file differences that haven't been staged |
|
||||
|
||||
| Command | Description |
|
||||
| --- | --- |
|
||||
| `git status` | List all *new or modified* files |
|
||||
| `git diff` | Show file differences that **haven't been** staged |
|
||||
|
||||
| Left-aligned | Center-aligned | Right-aligned |
|
||||
| :--- | :---: | ---: |
|
||||
| git status | git status | git status |
|
||||
| git diff | git diff | git diff |
|
||||
|
||||
| Name | Character |
|
||||
| --- | --- |
|
||||
| Backtick | ` |
|
||||
| Pipe | \| |
|
||||
|
||||
------
|
||||
|
||||
# Blockquotes
|
||||
|
||||
```
|
||||
> Blockquotes are very handy in email to emulate reply text.
|
||||
> This line is part of the same quote.
|
||||
|
||||
Quote break.
|
||||
|
||||
> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can *put* **Markdown** into a blockquote.
|
||||
|
||||
> Blockquotes can also be nested...
|
||||
>> ...by using additional greater-than signs right next to each other...
|
||||
> > > ...or with spaces between arrows.
|
||||
```
|
||||
|
||||
> Blockquotes are very handy in email to emulate reply text.
|
||||
> This line is part of the same quote.
|
||||
|
||||
Quote break.
|
||||
|
||||
> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can *put* **Markdown** into a blockquote.
|
||||
|
||||
> Blockquotes can also be nested...
|
||||
>> ...by using additional greater-than signs right next to each other...
|
||||
> > > ...or with spaces between arrows.
|
||||
|
||||
------
|
||||
|
||||
# Inline HTML
|
||||
|
||||
```
|
||||
<dl>
|
||||
<dt>Definition list</dt>
|
||||
<dd>Is something people use sometimes.</dd>
|
||||
|
||||
<dt>Markdown in HTML</dt>
|
||||
<dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>
|
||||
</dl>
|
||||
```
|
||||
|
||||
<dl>
|
||||
<dt>Definition list</dt>
|
||||
<dd>Is something people use sometimes.</dd>
|
||||
|
||||
<dt>Markdown in HTML</dt>
|
||||
<dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>
|
||||
</dl>
|
||||
|
||||
------
|
||||
|
||||
# Horizontal Rules
|
||||
|
||||
```
|
||||
Three or more...
|
||||
|
||||
---
|
||||
|
||||
Hyphens
|
||||
|
||||
***
|
||||
|
||||
Asterisks
|
||||
|
||||
___
|
||||
|
||||
Underscores
|
||||
```
|
||||
|
||||
Three or more...
|
||||
|
||||
---
|
||||
|
||||
Hyphens
|
||||
|
||||
***
|
||||
|
||||
Asterisks
|
||||
|
||||
___
|
||||
|
||||
Underscores
|
||||
|
||||
------
|
||||
|
||||
# YouTube Videos
|
||||
|
||||
```
|
||||
<a href="http://www.youtube.com/watch?feature=player_embedded&v=YOUTUBE_VIDEO_ID_HERE" target="_blank">
|
||||
<img src="http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg" alt="IMAGE ALT TEXT HERE" width="240" height="180" border="10">
|
||||
</a>
|
||||
```
|
||||
|
||||
<a href="http://www.youtube.com/watch?feature=player_embedded&v=YOUTUBE_VIDEO_ID_HERE" target="_blank">
|
||||
<img src="http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg" alt="IMAGE ALT TEXT HERE" width="240" height="180" border="10">
|
||||
</a>
|
||||
|
||||
```
|
||||
[](http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)
|
||||
```
|
||||
|
||||
[](https://www.youtube.com/watch?v=ciawICBvQoE)
|
||||
Loading…
Reference in a new issue