commit
7b9b377792
@ -0,0 +1,23 @@
|
||||
kind: pipeline
|
||||
type: docker
|
||||
name: CI
|
||||
|
||||
trigger:
|
||||
event:
|
||||
- push
|
||||
|
||||
steps:
|
||||
- name: generate-and-deploy-docs
|
||||
image: hub.codefirst.iut.uca.fr/thomas.bellembois/codefirst-docdeployer
|
||||
volumes:
|
||||
- name: docs
|
||||
path: /docs
|
||||
commands:
|
||||
- /entrypoint.sh
|
||||
when:
|
||||
branch:
|
||||
- main
|
||||
|
||||
volumes:
|
||||
- name: docs
|
||||
temp: {}
|
||||
@ -0,0 +1,20 @@
|
||||
# Dependencies
|
||||
/Documentation/docusaurus/node_modules
|
||||
|
||||
# Production
|
||||
/Documentation/docusaurus/build
|
||||
|
||||
# Generated files
|
||||
/Documentation/docusaurus.docusaurus
|
||||
/Documentation/docusaurus.cache-loader
|
||||
|
||||
# Misc
|
||||
.DS_Store
|
||||
.env.local
|
||||
.env.development.local
|
||||
.env.test.local
|
||||
.env.production.local
|
||||
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
@ -0,0 +1,3 @@
|
||||
module.exports = {
|
||||
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
|
||||
};
|
||||
@ -0,0 +1,9 @@
|
||||
{
|
||||
"label": "Folder",
|
||||
"position": 3,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Short description for this section"
|
||||
}
|
||||
}
|
||||
|
||||
@ -0,0 +1,96 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
title: Page with code samples
|
||||
description : How to insert code snippets?
|
||||
---
|
||||
|
||||
# How to insert code snippets?
|
||||
|
||||
You can insert code snippets by using the following notation:
|
||||
|
||||
```
|
||||
```
|
||||
My code snippet
|
||||
```
|
||||
```
|
||||
|
||||
giving this:
|
||||
```
|
||||
My code snippet
|
||||
```
|
||||
|
||||
You can also specify the language, like that:
|
||||
|
||||
```
|
||||
```csharp
|
||||
using System;
|
||||
|
||||
namespace SampleNamespace
|
||||
{
|
||||
public class MyClass
|
||||
{
|
||||
public void DoNothing()
|
||||
{
|
||||
Console.WriteLine("Do nothing");
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
```
|
||||
|
||||
giving this:
|
||||
```csharp
|
||||
using System;
|
||||
|
||||
namespace SampleNamespace
|
||||
{
|
||||
public class MyClass
|
||||
{
|
||||
public void DoNothing()
|
||||
{
|
||||
Console.WriteLine("Do nothing");
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
other sample in python:
|
||||
```python
|
||||
class Player:
|
||||
|
||||
_name = ""
|
||||
|
||||
def _get_name(self):
|
||||
return self._name
|
||||
|
||||
def _set_name(self, name):
|
||||
if name.isspace() or (not name) :
|
||||
self._name = "Jane Doe"
|
||||
else :
|
||||
self._name = name
|
||||
|
||||
## name of this Player
|
||||
name = property(_get_name, _set_name)
|
||||
|
||||
_id = 0
|
||||
|
||||
def _get_id(self):
|
||||
return self._id
|
||||
|
||||
def _set_id(self, id):
|
||||
if id <= 0:
|
||||
raise Exception("id can not be equal or inferior to 0")
|
||||
self._id = id
|
||||
|
||||
## id of this Player (read only)
|
||||
id = property(_get_id)
|
||||
|
||||
|
||||
## initializer
|
||||
# @param name the name of this Player (can not be null, empty or white spaces, otherwise, it will be changed to Jane Doe)
|
||||
# @param id the id of this Player (can not be less or equal to 0)
|
||||
# @return an instance of the Player class initialized with the specified name and id.
|
||||
def __init__(self, name, id):
|
||||
self.name = name
|
||||
self._set_id(id)
|
||||
```
|
||||
@ -0,0 +1,36 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: Page with hints
|
||||
description : How to insert hints?
|
||||
---
|
||||
|
||||
# How to insert hints?
|
||||
|
||||
You can add tips, info, hints, warnings, using this syntax:
|
||||
|
||||
```
|
||||
:::note A note
|
||||
A note
|
||||
:::
|
||||
```
|
||||
|
||||
:::note A note
|
||||
A note
|
||||
:::
|
||||
|
||||
:::info An info
|
||||
An info
|
||||
:::
|
||||
|
||||
:::warning A warning
|
||||
A warning
|
||||
:::
|
||||
|
||||
:::caution A caution
|
||||
A caution
|
||||
:::
|
||||
|
||||
:::tip A tip
|
||||
A tip
|
||||
:::
|
||||
|
||||
@ -0,0 +1,21 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: Page with images
|
||||
description : Sample of a page with images
|
||||
---
|
||||
|
||||
# How to use images in a page?
|
||||
|
||||
You can use images by using these notation:
|
||||
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
for instance here:
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
and here is the result:
|
||||
|
||||
|
After Width: | Height: | Size: 13 KiB |
@ -0,0 +1,17 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
title: Page with Math equations
|
||||
description : How to insert Math equations (KaTeX)?
|
||||
---
|
||||
|
||||
# How to insert Math equations (KaTeX)?
|
||||
|
||||
$$
|
||||
I = \int_0^{2\pi} \sin(x)\,dx
|
||||
$$
|
||||
|
||||
$$
|
||||
f(\relax{x}) = \int_{-\infty}^\infty
|
||||
\hat f(\relax{\xi})e^{2 \pi i \xi x}
|
||||
\,d\xi
|
||||
$$
|
||||
@ -0,0 +1,143 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
title: Page with Mermaid diagrams
|
||||
description : How to insert Mermaid diagrams?
|
||||
---
|
||||
import Mermaid from '@theme/Mermaid';
|
||||
|
||||
# How to insert Mermaid diagrams?
|
||||
|
||||
## Flow chart
|
||||
|
||||
```mermaid
|
||||
graph TD;
|
||||
A-->B;
|
||||
A-->C;
|
||||
B-->D;
|
||||
C-->D;
|
||||
```
|
||||
|
||||
## Sequence diagram
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant Alice
|
||||
participant Bob
|
||||
Alice->>John: Hello John, how are you?
|
||||
loop Healthcheck
|
||||
John->>John: Fight against hypochondria
|
||||
end
|
||||
Note right of John: Rational thoughts <br/>prevail!
|
||||
John-->>Alice: Great!
|
||||
John->>Bob: How about you?
|
||||
Bob-->>John: Jolly good!
|
||||
```
|
||||
|
||||
## Gantt diagram
|
||||
|
||||
```mermaid
|
||||
gantt
|
||||
dateFormat YYYY-MM-DD
|
||||
title Adding GANTT diagram to mermaid
|
||||
excludes weekdays 2014-01-10
|
||||
|
||||
section A section
|
||||
Completed task :done, des1, 2014-01-06,2014-01-08
|
||||
Active task :active, des2, 2014-01-09, 3d
|
||||
Future task : des3, after des2, 5d
|
||||
Future task2 : des4, after des3, 5d
|
||||
```
|
||||
|
||||
## Class diagram
|
||||
|
||||
```mermaid
|
||||
classDiagram
|
||||
Class01 <|-- AveryLongClass : Cool
|
||||
Class03 *-- Class04
|
||||
Class05 o-- Class06
|
||||
Class07 .. Class08
|
||||
Class09 --> C2 : Where am i?
|
||||
Class09 --* C3
|
||||
Class09 --|> Class07
|
||||
Class07 : equals()
|
||||
Class07 : Object[] elementData
|
||||
Class01 : size()
|
||||
Class01 : int chimp
|
||||
Class01 : int gorilla
|
||||
Class08 <--> C2: Cool label
|
||||
```
|
||||
|
||||
## Git graph
|
||||
|
||||
```mermaid
|
||||
gitGraph
|
||||
commit
|
||||
commit
|
||||
branch develop
|
||||
commit
|
||||
commit
|
||||
commit
|
||||
checkout main
|
||||
commit
|
||||
commit
|
||||
```
|
||||
|
||||
## State diagram
|
||||
|
||||
```mermaid
|
||||
stateDiagram-v2
|
||||
[*] --> Still
|
||||
Still --> [*]
|
||||
|
||||
Still --> Moving
|
||||
Moving --> Still
|
||||
Moving --> Crash
|
||||
Crash --> [*]
|
||||
```
|
||||
|
||||
## Entity Relationships diagram
|
||||
|
||||
```mermaid
|
||||
erDiagram
|
||||
CAR ||--o{ NAMED-DRIVER : allows
|
||||
CAR {
|
||||
string registrationNumber
|
||||
string make
|
||||
string model
|
||||
}
|
||||
PERSON ||--o{ NAMED-DRIVER : is
|
||||
PERSON {
|
||||
string firstName
|
||||
string lastName
|
||||
int age
|
||||
}
|
||||
```
|
||||
|
||||
## User journey diagram
|
||||
|
||||
```mermaid
|
||||
journey
|
||||
title My working day
|
||||
section Go to work
|
||||
Make tea: 5: Me
|
||||
Go upstairs: 3: Me
|
||||
Do work: 1: Me, Cat
|
||||
section Go home
|
||||
Go downstairs: 5: Me
|
||||
Sit down: 5: Me
|
||||
```
|
||||
|
||||
## Pie chart
|
||||
|
||||
```mermaid
|
||||
pie showData
|
||||
title Key elements in Product X
|
||||
"Calcium" : 42.96
|
||||
"Potassium" : 50.05
|
||||
"Magnesium" : 10.01
|
||||
"Iron" : 5
|
||||
```
|
||||
|
||||
## More
|
||||
|
||||
Many more on [mermaid site](https://mermaid-js.github.io/mermaid/)
|
||||
@ -0,0 +1,13 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: Page with a video
|
||||
description : How to insert a video?
|
||||
---
|
||||
|
||||
# How to insert a video?
|
||||
|
||||
You can easily insert a video from UCA Media Manager, like this:
|
||||
<iframe allowfullscreen src='https://opencast.dsi.uca.fr/paella/ui/embed.html?id=6bb85997-4724-46a2-b0d8-17cd6d55b1db' width='640' height='400' frameborder='0' scrolling='no' marginwidth='0' marginheight='0' allowfullscreen='true' webkitallowfullscreen='true' mozallowfullscreen='true' ></iframe>
|
||||
|
||||
Or from youtube:
|
||||
<iframe width="560" height="315" src="https://www.youtube.com/embed/3SH_MbMJwxI" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
@ -0,0 +1,7 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Third page
|
||||
|
||||
another page...
|
||||
@ -0,0 +1,7 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# First page
|
||||
|
||||
You can use this section as an introduction page.
|
||||
@ -0,0 +1,7 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Second page
|
||||
|
||||
Another page...
|
||||
@ -0,0 +1,172 @@
|
||||
// @ts-check
|
||||
// Note: type annotations allow type checking and IDEs autocompletion
|
||||
|
||||
const lightCodeTheme = require('prism-react-renderer/themes/github');
|
||||
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
|
||||
|
||||
/** @type {import('@docusaurus/types').Config} */
|
||||
const math = require('remark-math');
|
||||
const katex = require('rehype-katex');
|
||||
|
||||
|
||||
const config = {
|
||||
title: 'My Documentation',
|
||||
tagline: 'My tagline',
|
||||
url: 'https://codefirst.iut.uca.fr',
|
||||
baseUrl: '/documentation/augustin.affognon/docusaurus/MeteoApp/',
|
||||
onBrokenLinks: 'throw',
|
||||
onBrokenMarkdownLinks: 'warn',
|
||||
favicon: 'img/favicon.ico',
|
||||
trailingSlash: true,
|
||||
|
||||
// GitHub pages deployment config.
|
||||
// If you aren't using GitHub pages, you don't need these.
|
||||
organizationName: 'augustin.affognon', // Usually your GitHub org/user name.
|
||||
projectName: 'MeteoApp', // Usually your repo name.
|
||||
|
||||
// Even if you don't use internalization, you can use this field to set useful
|
||||
// metadata like html lang. For example, if your site is Chinese, you may want
|
||||
// to replace "en" with "zh-Hans".
|
||||
i18n: {
|
||||
defaultLocale: 'en',
|
||||
locales: ['en', 'fr'],
|
||||
localeConfigs: {
|
||||
en:{
|
||||
htmlLang: 'en-GB',
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
presets: [
|
||||
[
|
||||
'classic',
|
||||
/** @type {import('@docusaurus/preset-classic').Options} */
|
||||
({
|
||||
docs: {
|
||||
sidebarPath: require.resolve('./sidebars.js'),
|
||||
// Please change this to your repo.
|
||||
// Remove this to remove the "edit this page" links.
|
||||
// editUrl:
|
||||
// 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
|
||||
remarkPlugins: [math],
|
||||
rehypePlugins: [katex],
|
||||
},
|
||||
blog: {
|
||||
showReadingTime: true,
|
||||
// Please change this to your repo.
|
||||
// Remove this to remove the "edit this page" links.
|
||||
// editUrl:
|
||||
// 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
|
||||
blogSidebarTitle: 'All posts',
|
||||
blogSidebarCount: 'ALL',
|
||||
},
|
||||
theme: {
|
||||
customCss: require.resolve('./src/css/custom.css'),
|
||||
},
|
||||
}),
|
||||
],
|
||||
],
|
||||
stylesheets: [
|
||||
{
|
||||
href: 'https://cdn.jsdelivr.net/npm/katex@0.13.24/dist/katex.min.css',
|
||||
type: 'text/css',
|
||||
integrity:
|
||||
'sha384-odtC+0UGzzFL/6PNoE8rX/SPcQDXBJ+uRepguP4QkPCm2LBxH3FA3y+fKSiJ+AmM',
|
||||
crossorigin: 'anonymous',
|
||||
},
|
||||
],
|
||||
themeConfig:
|
||||
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
||||
({
|
||||
navbar: {
|
||||
title: '',
|
||||
logo: {
|
||||
alt: 'CodeFirst',
|
||||
src: 'img/logo.svg',
|
||||
srcDark: 'img/LOGO_CODE1ERT_BLANC_VERT.svg'
|
||||
},
|
||||
items: [
|
||||
{
|
||||
type: 'doc',
|
||||
docId: 'intro',
|
||||
position: 'left',
|
||||
label: 'Documentation',
|
||||
},
|
||||
// {to: '/blog', label: 'Blog', position: 'left'},
|
||||
// {to: '/classesPage', label: 'Courses', position: 'left'},
|
||||
{
|
||||
type: 'localeDropdown',
|
||||
position: 'right',
|
||||
},
|
||||
// {
|
||||
// href: 'https://codefirst.iut.uca.fr/',
|
||||
// label: 'Start',
|
||||
// position: 'right',
|
||||
// },
|
||||
|
||||
],
|
||||
},
|
||||
footer: {
|
||||
style: 'dark',
|
||||
links: [
|
||||
{
|
||||
title: 'Docs',
|
||||
items: [
|
||||
{
|
||||
label: 'Documentation',
|
||||
to: '/docs/intro',
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'More',
|
||||
items: [
|
||||
// {
|
||||
// label: 'Blog',
|
||||
// to: '/blog',
|
||||
// },
|
||||
{
|
||||
label: 'Code#0',
|
||||
href: 'https://codefirst.iut.uca.fr/',
|
||||
},
|
||||
],
|
||||
},
|
||||
// {
|
||||
// title: 'Community',
|
||||
// items: [
|
||||
// {
|
||||
// label: 'LinkedIn',
|
||||
// href: 'https://www.linkedin.com/company/code-1st/',
|
||||
// },
|
||||
// ],
|
||||
// },
|
||||
|
||||
],
|
||||
copyright: `Copyright © new Date().getFullYear() Code#0.`,
|
||||
},
|
||||
prism: {
|
||||
additionalLanguages: ['csharp', 'python', 'java'],
|
||||
theme: lightCodeTheme,
|
||||
darkTheme: darkCodeTheme,
|
||||
magicComments: [
|
||||
// Remember to extend the default highlight class name as well!
|
||||
{
|
||||
className: 'theme-code-block-highlighted-line',
|
||||
line: 'highlight-next-line',
|
||||
block: {start: 'highlight-start', end: 'highlight-end'},
|
||||
},
|
||||
{
|
||||
className: 'myOneAndOnlyHightlightedCodeBlock',
|
||||
line: 'my-highlight-next-line',
|
||||
block: {start: 'my-highlight-start', end: 'my-highlight-end'},
|
||||
},
|
||||
],
|
||||
},
|
||||
}),
|
||||
markdown: {
|
||||
mermaid: true,
|
||||
},
|
||||
themes: ['@docusaurus/theme-mermaid'],
|
||||
};
|
||||
|
||||
module.exports = config;
|
||||
@ -0,0 +1,271 @@
|
||||
{
|
||||
"theme.ErrorPageContent.title": {
|
||||
"message": "Cette page a planté.",
|
||||
"description": "The title of the fallback page when the page crashed"
|
||||
},
|
||||
"theme.ErrorPageContent.tryAgain": {
|
||||
"message": "Réessayer",
|
||||
"description": "The label of the button to try again when the page crashed"
|
||||
},
|
||||
"theme.NotFound.title": {
|
||||
"message": "Page introuvable",
|
||||
"description": "The title of the 404 page"
|
||||
},
|
||||
"theme.NotFound.p1": {
|
||||
"message": "Nous n'avons pas trouvé ce que vous recherchez.",
|
||||
"description": "The first paragraph of the 404 page"
|
||||
},
|
||||
"theme.NotFound.p2": {
|
||||
"message": "Veuillez contacter le propriétaire du site qui vous a lié à l'URL d'origine et leur faire savoir que leur lien est cassé.",
|
||||
"description": "The 2nd paragraph of the 404 page"
|
||||
},
|
||||
"theme.admonition.note": {
|
||||
"message": "remarque",
|
||||
"description": "The default label used for the Note admonition (:::note)"
|
||||
},
|
||||
"theme.admonition.tip": {
|
||||
"message": "astuce",
|
||||
"description": "The default label used for the Tip admonition (:::tip)"
|
||||
},
|
||||
"theme.admonition.danger": {
|
||||
"message": "danger",
|
||||
"description": "The default label used for the Danger admonition (:::danger)"
|
||||
},
|
||||
"theme.admonition.info": {
|
||||
"message": "info",
|
||||
"description": "The default label used for the Info admonition (:::info)"
|
||||
},
|
||||
"theme.admonition.caution": {
|
||||
"message": "attention",
|
||||
"description": "The default label used for the Caution admonition (:::caution)"
|
||||
},
|
||||
"theme.blog.archive.title": {
|
||||
"message": "Archive",
|
||||
"description": "The page & hero title of the blog archive page"
|
||||
},
|
||||
"theme.blog.archive.description": {
|
||||
"message": "Archive",
|
||||
"description": "The page & hero description of the blog archive page"
|
||||
},
|
||||
"theme.blog.paginator.navAriaLabel": {
|
||||
"message": "Pagination de la liste des articles du blog",
|
||||
"description": "The ARIA label for the blog pagination"
|
||||
},
|
||||
"theme.blog.paginator.newerEntries": {
|
||||
"message": "Nouvelles entrées",
|
||||
"description": "The label used to navigate to the newer blog posts page (previous page)"
|
||||
},
|
||||
"theme.blog.paginator.olderEntries": {
|
||||
"message": "Anciennes entrées",
|
||||
"description": "The label used to navigate to the older blog posts page (next page)"
|
||||
},
|
||||
"theme.BackToTopButton.buttonAriaLabel": {
|
||||
"message": "Retour au début de la page",
|
||||
"description": "The ARIA label for the back to top button"
|
||||
},
|
||||
"theme.blog.post.paginator.navAriaLabel": {
|
||||
"message": "Pagination des articles du blog",
|
||||
"description": "The ARIA label for the blog posts pagination"
|
||||
},
|
||||
"theme.blog.post.paginator.newerPost": {
|
||||
"message": "Article plus récent",
|
||||
"description": "The blog post button label to navigate to the newer/previous post"
|
||||
},
|
||||
"theme.blog.post.paginator.olderPost": {
|
||||
"message": "Article plus ancien",
|
||||
"description": "The blog post button label to navigate to the older/next post"
|
||||
},
|
||||
"theme.blog.post.plurals": {
|
||||
"message": "Un article|{count} articles",
|
||||
"description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)"
|
||||
},
|
||||
"theme.blog.tagTitle": {
|
||||
"message": "{nPosts} tagués avec « {tagName} »",
|
||||
"description": "The title of the page for a blog tag"
|
||||
},
|
||||
"theme.tags.tagsPageLink": {
|
||||
"message": "Voir tous les tags",
|
||||
"description": "The label of the link targeting the tag list page"
|
||||
},
|
||||
"theme.colorToggle.ariaLabel": {
|
||||
"message": "Basculer entre le mode sombre et clair (actuellement {mode})",
|
||||
"description": "The ARIA label for the navbar color mode toggle"
|
||||
},
|
||||
"theme.colorToggle.ariaLabel.mode.dark": {
|
||||
"message": "mode sombre",
|
||||
"description": "The name for the dark color mode"
|
||||
},
|
||||
"theme.colorToggle.ariaLabel.mode.light": {
|
||||
"message": "mode clair",
|
||||
"description": "The name for the light color mode"
|
||||
},
|
||||
"theme.docs.breadcrumbs.home": {
|
||||
"message": "Page d'accueil",
|
||||
"description": "The ARIA label for the home page in the breadcrumbs"
|
||||
},
|
||||
"theme.docs.breadcrumbs.navAriaLabel": {
|
||||
"message": "Fil d'Ariane",
|
||||
"description": "The ARIA label for the breadcrumbs"
|
||||
},
|
||||
"theme.docs.DocCard.categoryDescription": {
|
||||
"message": "{count} éléments",
|
||||
"description": "The default description for a category card in the generated index about how many items this category includes"
|
||||
},
|
||||
"theme.docs.paginator.navAriaLabel": {
|
||||
"message": "Pagination des documents",
|
||||
"description": "The ARIA label for the docs pagination"
|
||||
},
|
||||
"theme.docs.paginator.previous": {
|
||||
"message": "Précédent",
|
||||
"description": "The label used to navigate to the previous doc"
|
||||
},
|
||||
"theme.docs.paginator.next": {
|
||||
"message": "Suivant",
|
||||
"description": "The label used to navigate to the next doc"
|
||||
},
|
||||
"theme.docs.tagDocListPageTitle.nDocsTagged": {
|
||||
"message": "Un document tagué|{count} documents tagués",
|
||||
"description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)"
|
||||
},
|
||||
"theme.docs.tagDocListPageTitle": {
|
||||
"message": "{nDocsTagged} avec \"{tagName}\"",
|
||||
"description": "The title of the page for a docs tag"
|
||||
},
|
||||
"theme.docs.versionBadge.label": {
|
||||
"message": "Version: {versionLabel}"
|
||||
},
|
||||
"theme.common.editThisPage": {
|
||||
"message": "Éditer cette page",
|
||||
"description": "The link label to edit the current page"
|
||||
},
|
||||
"theme.docs.versions.unreleasedVersionLabel": {
|
||||
"message": "Ceci est la documentation de la prochaine version {versionLabel} de {siteTitle}.",
|
||||
"description": "The label used to tell the user that he's browsing an unreleased doc version"
|
||||
},
|
||||
"theme.docs.versions.unmaintainedVersionLabel": {
|
||||
"message": "Ceci est la documentation de {siteTitle} {versionLabel}, qui n'est plus activement maintenue.",
|
||||
"description": "The label used to tell the user that he's browsing an unmaintained doc version"
|
||||
},
|
||||
"theme.docs.versions.latestVersionSuggestionLabel": {
|
||||
"message": "Pour une documentation à jour, consultez la {latestVersionLink} ({versionLabel}).",
|
||||
"description": "The label used to tell the user to check the latest version"
|
||||
},
|
||||
"theme.docs.versions.latestVersionLinkLabel": {
|
||||
"message": "dernière version",
|
||||
"description": "The label used for the latest version suggestion link label"
|
||||
},
|
||||
"theme.common.headingLinkTitle": {
|
||||
"message": "Lien direct vers le titre",
|
||||
"description": "Title for link to heading"
|
||||
},
|
||||
"theme.lastUpdated.atDate": {
|
||||
"message": " le {date}",
|
||||
"description": "The words used to describe on which date a page has been last updated"
|
||||
},
|
||||
"theme.lastUpdated.byUser": {
|
||||
"message": " par {user}",
|
||||
"description": "The words used to describe by who the page has been last updated"
|
||||
},
|
||||
"theme.lastUpdated.lastUpdatedAtBy": {
|
||||
"message": "Dernière mise à jour{atDate}{byUser}",
|
||||
"description": "The sentence used to display when a page has been last updated, and by who"
|
||||
},
|
||||
"theme.navbar.mobileVersionsDropdown.label": {
|
||||
"message": "Versions",
|
||||
"description": "The label for the navbar versions dropdown on mobile view"
|
||||
},
|
||||
"theme.common.skipToMainContent": {
|
||||
"message": "Aller au contenu principal",
|
||||
"description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation"
|
||||
},
|
||||
"theme.tags.tagsListLabel": {
|
||||
"message": "Tags :",
|
||||
"description": "The label alongside a tag list"
|
||||
},
|
||||
"theme.AnnouncementBar.closeButtonAriaLabel": {
|
||||
"message": "Fermer",
|
||||
"description": "The ARIA label for close button of announcement bar"
|
||||
},
|
||||
"theme.blog.sidebar.navAriaLabel": {
|
||||
"message": "Navigation article de blog récent",
|
||||
"description": "The ARIA label for recent posts in the blog sidebar"
|
||||
},
|
||||
"theme.CodeBlock.copied": {
|
||||
"message": "Copié",
|
||||
"description": "The copied button label on code blocks"
|
||||
},
|
||||
"theme.CodeBlock.copyButtonAriaLabel": {
|
||||
"message": "Copier le code",
|
||||
"description": "The ARIA label for copy code blocks button"
|
||||
},
|
||||
"theme.CodeBlock.copy": {
|
||||
"message": "Copier",
|
||||
"description": "The copy button label on code blocks"
|
||||
},
|
||||
"theme.CodeBlock.wordWrapToggle": {
|
||||
"message": "Activer/désactiver le retour à la ligne",
|
||||
"description": "The title attribute for toggle word wrapping button of code block lines"
|
||||
},
|
||||
"theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel": {
|
||||
"message": "Plier/Déplier la catégorie '{label}' de la barre latérale",
|
||||
"description": "The ARIA label to toggle the collapsible sidebar category"
|
||||
},
|
||||
"theme.navbar.mobileLanguageDropdown.label": {
|
||||
"message": "Langues",
|
||||
"description": "The label for the mobile language switcher dropdown"
|
||||
},
|
||||
"theme.TOCCollapsible.toggleButtonLabel": {
|
||||
"message": "Sur cette page",
|
||||
"description": "The label used by the button on the collapsible TOC component"
|
||||
},
|
||||
"theme.blog.post.readMore": {
|
||||
"message": "Lire plus",
|
||||
"description": "The label used in blog post item excerpts to link to full blog posts"
|
||||
},
|
||||
"theme.blog.post.readMoreLabel": {
|
||||
"message": "En savoir plus sur {title}",
|
||||
"description": "The ARIA label for the link to full blog posts from excerpts"
|
||||
},
|
||||
"theme.blog.post.readingTime.plurals": {
|
||||
"message": "Une minute de lecture|{readingTime} minutes de lecture",
|
||||
"description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)"
|
||||
},
|
||||
"theme.docs.sidebar.collapseButtonTitle": {
|
||||
"message": "Réduire le menu latéral",
|
||||
"description": "The title attribute for collapse button of doc sidebar"
|
||||
},
|
||||
"theme.docs.sidebar.collapseButtonAriaLabel": {
|
||||
"message": "Réduire le menu latéral",
|
||||
"description": "The title attribute for collapse button of doc sidebar"
|
||||
},
|
||||
"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": {
|
||||
"message": "← Retour au menu principal",
|
||||
"description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)"
|
||||
},
|
||||
"theme.docs.sidebar.expandButtonTitle": {
|
||||
"message": "Déplier le menu latéral",
|
||||
"description": "The ARIA label and title attribute for expand button of doc sidebar"
|
||||
},
|
||||
"theme.docs.sidebar.expandButtonAriaLabel": {
|
||||
"message": "Déplier le menu latéral",
|
||||
"description": "The ARIA label and title attribute for expand button of doc sidebar"
|
||||
},
|
||||
"theme.tags.tagsPageTitle": {
|
||||
"message": "Tags",
|
||||
"description": "The title of the tag list page"
|
||||
},
|
||||
"homePage.goToDocumentation": {
|
||||
"message": "Lire la documentation maintenant ! 💻"
|
||||
},
|
||||
"homePage.aboutSectionTitle": {
|
||||
"message": "À propos de cette documentation"
|
||||
},
|
||||
"homePage.siteconfig.title": {
|
||||
"message": "Ma documentation",
|
||||
"description": "Guides and tutorials"
|
||||
},
|
||||
"homePage.siteconfig.tagline": {
|
||||
"message": "C'est ma documentation à moi",
|
||||
"description": "CI & CD at its best"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,14 @@
|
||||
{
|
||||
"title": {
|
||||
"message": "Blog",
|
||||
"description": "The title for the blog used in SEO"
|
||||
},
|
||||
"description": {
|
||||
"message": "Blog",
|
||||
"description": "The description for the blog used in SEO"
|
||||
},
|
||||
"sidebar.title": {
|
||||
"message": "Recent posts",
|
||||
"description": "The label for the left sidebar"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,14 @@
|
||||
{
|
||||
"version.label": {
|
||||
"message": "Suivant",
|
||||
"description": "The label for version current"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.Folder": {
|
||||
"message": "Dossier",
|
||||
"description": "The label for category Folder in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.Folder.link.generated-index.description": {
|
||||
"message": "Courte description pour cette section",
|
||||
"description": "The generated-index page description for category Folder in sidebar tutorialSidebar"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,9 @@
|
||||
{
|
||||
"label": "Folder",
|
||||
"position": 3,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Short description for this section"
|
||||
}
|
||||
}
|
||||
|
||||
@ -0,0 +1,96 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
title: Page with code samples
|
||||
description : How to insert code snippets?
|
||||
---
|
||||
|
||||
# How to insert code snippets?
|
||||
|
||||
You can insert code snippets by using the following notation:
|
||||
|
||||
```
|
||||
```
|
||||
My code snippet
|
||||
```
|
||||
```
|
||||
|
||||
giving this:
|
||||
```
|
||||
My code snippet
|
||||
```
|
||||
|
||||
You can also specify the language, like that:
|
||||
|
||||
```
|
||||
```csharp
|
||||
using System;
|
||||
|
||||
namespace SampleNamespace
|
||||
{
|
||||
public class MyClass
|
||||
{
|
||||
public void DoNothing()
|
||||
{
|
||||
Console.WriteLine("Do nothing");
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
```
|
||||
|
||||
giving this:
|
||||
```csharp
|
||||
using System;
|
||||
|
||||
namespace SampleNamespace
|
||||
{
|
||||
public class MyClass
|
||||
{
|
||||
public void DoNothing()
|
||||
{
|
||||
Console.WriteLine("Do nothing");
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
other sample in python:
|
||||
```python
|
||||
class Player:
|
||||
|
||||
_name = ""
|
||||
|
||||
def _get_name(self):
|
||||
return self._name
|
||||
|
||||
def _set_name(self, name):
|
||||
if name.isspace() or (not name) :
|
||||
self._name = "Jane Doe"
|
||||
else :
|
||||
self._name = name
|
||||
|
||||
## name of this Player
|
||||
name = property(_get_name, _set_name)
|
||||
|
||||
_id = 0
|
||||
|
||||
def _get_id(self):
|
||||
return self._id
|
||||
|
||||
def _set_id(self, id):
|
||||
if id <= 0:
|
||||
raise Exception("id can not be equal or inferior to 0")
|
||||
self._id = id
|
||||
|
||||
## id of this Player (read only)
|
||||
id = property(_get_id)
|
||||
|
||||
|
||||
## initializer
|
||||
# @param name the name of this Player (can not be null, empty or white spaces, otherwise, it will be changed to Jane Doe)
|
||||
# @param id the id of this Player (can not be less or equal to 0)
|
||||
# @return an instance of the Player class initialized with the specified name and id.
|
||||
def __init__(self, name, id):
|
||||
self.name = name
|
||||
self._set_id(id)
|
||||
```
|
||||
@ -0,0 +1,36 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: Page with hints
|
||||
description : How to insert hints?
|
||||
---
|
||||
|
||||
# How to insert hints?
|
||||
|
||||
You can add tips, info, hints, warnings, using this syntax:
|
||||
|
||||
```
|
||||
:::note A note
|
||||
A note
|
||||
:::
|
||||
```
|
||||
|
||||
:::note A note
|
||||
A note
|
||||
:::
|
||||
|
||||
:::info An info
|
||||
An info
|
||||
:::
|
||||
|
||||
:::warning A warning
|
||||
A warning
|
||||
:::
|
||||
|
||||
:::caution A caution
|
||||
A caution
|
||||
:::
|
||||
|
||||
:::tip A tip
|
||||
A tip
|
||||
:::
|
||||
|
||||
@ -0,0 +1,21 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: Page with images
|
||||
description : Sample of a page with images
|
||||
---
|
||||
|
||||
# How to use images in a page?
|
||||
|
||||
You can use images by using these notation:
|
||||
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
for instance here:
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
and here is the result:
|
||||
|
||||
|
After Width: | Height: | Size: 13 KiB |
@ -0,0 +1,13 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: Page with a video
|
||||
description : How to insert a video?
|
||||
---
|
||||
|
||||
# How to insert a video?
|
||||
|
||||
You can easily insert a video from UCA Media Manager, like this:
|
||||
<iframe allowfullscreen src='https://opencast.dsi.uca.fr/paella/ui/embed.html?id=6bb85997-4724-46a2-b0d8-17cd6d55b1db' width='640' height='400' frameborder='0' scrolling='no' marginwidth='0' marginheight='0' allowfullscreen='true' webkitallowfullscreen='true' mozallowfullscreen='true' ></iframe>
|
||||
|
||||
Or from youtube:
|
||||
<iframe width="560" height="315" src="https://www.youtube.com/embed/3SH_MbMJwxI" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
@ -0,0 +1,7 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Third page
|
||||
|
||||
another page...
|
||||
@ -0,0 +1,7 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# First page
|
||||
|
||||
You can use this section as an introduction page.
|
||||
@ -0,0 +1,7 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Second page
|
||||
|
||||
Another page...
|
||||
@ -0,0 +1,22 @@
|
||||
{
|
||||
"copyright": {
|
||||
"message": "Copyright © 2022 Code#0.",
|
||||
"description": "The footer copyright"
|
||||
},
|
||||
"link.item.label.Documentation": {
|
||||
"message": "Documentation",
|
||||
"description": "The label of footer link with label=Documentation linking to /docs/intro"
|
||||
},
|
||||
"link.title.Docs": {
|
||||
"message": "Docs",
|
||||
"description": "The title of the footer links column with title=Docs in the footer"
|
||||
},
|
||||
"link.title.More": {
|
||||
"message": "Plus",
|
||||
"description": "The title of the footer links column with title=More in the footer"
|
||||
},
|
||||
"link.item.label.Code#0": {
|
||||
"message": "Code#0",
|
||||
"description": "The label of footer link with label=Code#0 linking to https://codefirst.iut.uca.fr/"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,18 @@
|
||||
{
|
||||
"title": {
|
||||
"message": "",
|
||||
"description": "The title in the navbar"
|
||||
},
|
||||
"item.label.Documents": {
|
||||
"message": "Documents",
|
||||
"description": "Navbar item with label Documents"
|
||||
},
|
||||
"item.label.Blog": {
|
||||
"message": "Blog",
|
||||
"description": "Navbar item with label Blog"
|
||||
},
|
||||
"item.label.Documentation": {
|
||||
"message": "Documentation",
|
||||
"description": "Navbar item with label Documentation"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,49 @@
|
||||
{
|
||||
"name": "DocTemplate",
|
||||
"version": "0.0.0",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"docusaurus": "docusaurus",
|
||||
"start": "docusaurus start",
|
||||
"build": "docusaurus build",
|
||||
"swizzle": "docusaurus swizzle",
|
||||
"deploy": "docusaurus deploy",
|
||||
"clear": "docusaurus clear",
|
||||
"serve": "docusaurus serve",
|
||||
"write-translations": "docusaurus write-translations",
|
||||
"write-heading-ids": "docusaurus write-heading-ids"
|
||||
},
|
||||
"dependencies": {
|
||||
"@docusaurus/core": "2.2.0",
|
||||
"@docusaurus/preset-classic": "2.2.0",
|
||||
"@docusaurus/theme-mermaid": "^2.2.0",
|
||||
"@mdx-js/react": "^1.6.22",
|
||||
"clsx": "^1.2.1",
|
||||
"embla-carousel-autoplay": "6.0.0",
|
||||
"embla-carousel-react": "^6.0.0",
|
||||
"hast-util-is-element": "^1.1.0",
|
||||
"prism-react-renderer": "^1.3.5",
|
||||
"react": "^17.0.2",
|
||||
"react-dom": "^17.0.2",
|
||||
"rehype-katex": "^5.0.0",
|
||||
"remark-math": "^3.0.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@docusaurus/module-type-aliases": "2.2.0"
|
||||
},
|
||||
"browserslist": {
|
||||
"production": [
|
||||
">0.5%",
|
||||
"not dead",
|
||||
"not op_mini all"
|
||||
],
|
||||
"development": [
|
||||
"last 1 chrome version",
|
||||
"last 1 firefox version",
|
||||
"last 1 safari version"
|
||||
]
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=16.14"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,33 @@
|
||||
/**
|
||||
* Creating a sidebar enables you to:
|
||||
- create an ordered group of docs
|
||||
- render a sidebar for each doc of that group
|
||||
- provide next/previous navigation
|
||||
|
||||
The sidebars can be generated from the filesystem, or explicitly defined here.
|
||||
|
||||
Create as many sidebars as you want.
|
||||
*/
|
||||
|
||||
// @ts-check
|
||||
|
||||
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
|
||||
const sidebars = {
|
||||
// By default, Docusaurus generates a sidebar from the docs folder structure
|
||||
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
|
||||
|
||||
// But you can create a sidebar manually
|
||||
/*
|
||||
tutorialSidebar: [
|
||||
'intro',
|
||||
'hello',
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Tutorial',
|
||||
items: ['tutorial-basics/create-a-document'],
|
||||
},
|
||||
],
|
||||
*/
|
||||
};
|
||||
|
||||
module.exports = sidebars;
|
||||
@ -0,0 +1,72 @@
|
||||
/**
|
||||
* Any CSS included here will be global. The classic template
|
||||
* bundles Infima by default. Infima is a CSS framework designed to
|
||||
* work well for content-centric websites.
|
||||
*/
|
||||
|
||||
/* You can override the default Infima variables here. */
|
||||
:root {
|
||||
color: var(--cf-color-primary);
|
||||
--ifm-color-primary: var(--cf-color-accent-secondary);
|
||||
--ifm-color-secondary: var(--cf-color-accent-primary);
|
||||
--ifm-color-primary-dark: var(--cf-color-accent-secondary);
|
||||
--ifm-color-secondary-dark: var(--cf-color-accent-secondary);
|
||||
--ifm-color-primary-darker: #277148;
|
||||
--ifm-color-primary-darkest: #205d3b;
|
||||
--ifm-color-primary-light: #33925d;
|
||||
--ifm-color-primary-lighter: #359962;
|
||||
--ifm-color-primary-lightest: #3cad6e;
|
||||
--ifm-code-font-size: 80%;
|
||||
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
|
||||
--cf-color-primary: #021d1e;
|
||||
--cf-color-secondary: #023c40;
|
||||
--cf-background-color-primary: #f0eff4;
|
||||
--cf-background-color-secondary: #bfb8ba;
|
||||
--cf-background-color-nocolor: #ffffff;
|
||||
--cf-background-color-footer: var(--cf-color-primary);
|
||||
--cf-color-accent-primary: #3ddc97;
|
||||
--cf-color-accent-secondary: #62929e;
|
||||
--cf-logo:"logo.svg";
|
||||
--border-radius-default: 20px;
|
||||
}
|
||||
|
||||
/* For readability concerns, you should choose a lighter palette in dark mode. */
|
||||
[data-theme='dark'] {
|
||||
color: var(--cf-color-primary);
|
||||
--ifm-color-primary: var(--cf-color-accent-secondary);
|
||||
--ifm-color-secondary: var(--cf-color-accent-primary);
|
||||
--ifm-color-primary-dark: var(--cf-color-accent-secondary);
|
||||
--ifm-color-secondary-dark: var(--cf-color-accent-secondary);
|
||||
--ifm-color-primary-darker: #1fa588;
|
||||
--ifm-color-primary-darkest: #1a8870;
|
||||
--ifm-color-primary-light: #29d5b0;
|
||||
--ifm-color-primary-lighter: #32d8b4;
|
||||
--ifm-color-primary-lightest: #4fddbf;
|
||||
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
|
||||
--cf-color-primary: #f0eff4;
|
||||
--cf-color-secondary: #bfb8ba;
|
||||
--cf-background-color-primary: #023c40;
|
||||
--cf-background-color-secondary: #021d1e;
|
||||
--cf-background-color-nocolor: #021d1e;
|
||||
--cf-color-accent-primary: #3ddc97;
|
||||
--cf-color-accent-secondary: #62929e;
|
||||
--cf-background-color-footer: var(--cf-background-color-secondary);
|
||||
--ifm-font-color-base:var(--cf-color-primary);
|
||||
--ifm-global-spacing: 1rem;
|
||||
--ifm-spacing-vertical: var(--ifm-global-spacing);
|
||||
--cf-logo:"LOGO_CODE1ERT_BLANC_VERT.svg";
|
||||
--ifm-navbar-background-color: var(--cf-background-color-secondary);
|
||||
}
|
||||
|
||||
.footer {
|
||||
--ifm-footer-background-color: var(--cf-background-color-footer);
|
||||
}
|
||||
|
||||
.myOneAndOnlyHightlightedCodeBlock {
|
||||
background-color: var(--cf-background-color-primary);
|
||||
display: block;
|
||||
margin: 0 calc(-1 * var(--ifm-pre-padding));
|
||||
padding: 0 var(--ifm-pre-padding);
|
||||
border-left: 3px solid var(--cf-color-accent-primary);
|
||||
}
|
||||
|
||||
@ -0,0 +1,58 @@
|
||||
/**
|
||||
* CSS files with the .module.css suffix will be treated as CSS modules
|
||||
* and scoped locally.
|
||||
*/
|
||||
|
||||
.heroBanner {
|
||||
padding: 4rem 0;
|
||||
text-align: center;
|
||||
position: relative;
|
||||
overflow: hidden;
|
||||
color: var(--cf-color-primary);
|
||||
background-color: var(--cf-background-color-primary);
|
||||
}
|
||||
|
||||
@media screen and (max-width: 996px) {
|
||||
.heroBanner {
|
||||
padding: 2rem;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Breakpoints for widths of devices:
|
||||
*
|
||||
* 320px—480px: Mobile devices
|
||||
* 481px—768px: iPads, Tablets
|
||||
* 769px—1024px: Small screens, laptops
|
||||
* 1025px—1200px: Desktops, large screens
|
||||
* 1201px and more: Extra large screens, TV
|
||||
*/
|
||||
|
||||
@media only screen and (max-device-width: 480px) {
|
||||
iframe {
|
||||
height: 250px;
|
||||
}
|
||||
}
|
||||
|
||||
.buttons {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
color: var(--cf-color-accent-primary);
|
||||
}
|
||||
|
||||
.myButton {
|
||||
background-color: var(--cf-color-accent-primary);
|
||||
}
|
||||
|
||||
.textDiv {
|
||||
margin: 50px;
|
||||
}
|
||||
|
||||
.aboutDiv {
|
||||
background-color:var(--cf-background-color-nocolor);
|
||||
padding-bottom:2rem;
|
||||
padding-top: 4vh;
|
||||
align-items:center;
|
||||
margin:0 auto;
|
||||
}
|
||||
|
After Width: | Height: | Size: 9.4 KiB |
|
After Width: | Height: | Size: 15 KiB |
|
After Width: | Height: | Size: 4.7 KiB |
@ -0,0 +1,41 @@
|
||||
# Website
|
||||
|
||||
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
|
||||
|
||||
### Installation
|
||||
|
||||
```
|
||||
$ yarn
|
||||
```
|
||||
|
||||
### Local Development
|
||||
|
||||
```
|
||||
$ yarn start
|
||||
```
|
||||
|
||||
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
|
||||
|
||||
### Build
|
||||
|
||||
```
|
||||
$ yarn build
|
||||
```
|
||||
|
||||
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
||||
|
||||
### Deployment
|
||||
|
||||
Using SSH:
|
||||
|
||||
```
|
||||
$ USE_SSH=true yarn deploy
|
||||
```
|
||||
|
||||
Not using SSH:
|
||||
|
||||
```
|
||||
$ GIT_USER=<Your GitHub username> yarn deploy
|
||||
```
|
||||
|
||||
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
|
||||
Loading…
Reference in new issue