From 61c34978759c2b84a500bd4e717ed62f91a7e633 Mon Sep 17 00:00:00 2001 From: Lucas Date: Sun, 26 Feb 2023 12:53:05 +0100 Subject: [PATCH 1/8] Improve documentation for Built-in Blog doc, add Structure and special characters parts --- _overviews/scala3-scaladoc/blog.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/_overviews/scala3-scaladoc/blog.md b/_overviews/scala3-scaladoc/blog.md index be9754820c..deb64df074 100644 --- a/_overviews/scala3-scaladoc/blog.md +++ b/_overviews/scala3-scaladoc/blog.md @@ -33,4 +33,28 @@ Scaladoc loads blog if the `_blog` directory exists. All the blogpost filenames should start with date in numeric format matching `YYYY-MM-DD`. Example name is `2015-10-23-dotty-compiler-bootstraps.md`. +## Structure +``` +--- +layout: A reference to the layout for the blog page +author: Name of the author of the page +title: Name of the author of the page +subTitle: Subtitle of the page +excerpt_separator: +date: Date of creation of the page +authorImg: Image of the author of the page +--- + +``` +Keep in mind that with the exception of the author's name and title, the fields are optional. + +## Special characters for structures + +```````` : For code + +`##Subtitle` : For subtitles + +`word` : To highlight + +`[word](Link to a website)`: If you want to put a link in a word \ No newline at end of file From 80560194df1956b00a72abaefb0dc60ca5756e4b Mon Sep 17 00:00:00 2001 From: Lucas Date: Wed, 1 Mar 2023 10:35:53 +0100 Subject: [PATCH 2/8] Corrections --- _overviews/scala3-scaladoc/blog.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/_overviews/scala3-scaladoc/blog.md b/_overviews/scala3-scaladoc/blog.md index deb64df074..1aff76fb55 100644 --- a/_overviews/scala3-scaladoc/blog.md +++ b/_overviews/scala3-scaladoc/blog.md @@ -35,25 +35,26 @@ Example name is `2015-10-23-dotty-compiler-bootstraps.md`. ## Structure +When creating a blog page, you will have a first part to fill in with different fields. See the following example: + ``` --- -layout: A reference to the layout for the blog page -author: Name of the author of the page -title: Name of the author of the page -subTitle: Subtitle of the page +layout: +author: +title: +subTitle: <Subtitle of the page> excerpt_separator: <!--more--> -date: Date of creation of the page -authorImg: Image of the author of the page +date: <Date of the creation of the page> +authorImg: <Link to the author's image> --- <Content> ``` -Keep in mind that with the exception of the author's name and title, the fields are optional. -## Special characters for structures +## Special characters for the content -````<content>```` : For code +` ```<content>``` ` : For code -`##Subtitle` : For subtitles +`## Subtitle` : For subtitles `word` : To highlight From de8a49c27ebdda809e354279f1e36d04a6e38c00 Mon Sep 17 00:00:00 2001 From: Lucas <leblanc.lucas29@gmail.com> Date: Thu, 2 Mar 2023 14:31:43 +0100 Subject: [PATCH 3/8] Corrections: Titles, explanation and nints --- _overviews/scala3-scaladoc/blog.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/_overviews/scala3-scaladoc/blog.md b/_overviews/scala3-scaladoc/blog.md index 1aff76fb55..2f6b6b0f68 100644 --- a/_overviews/scala3-scaladoc/blog.md +++ b/_overviews/scala3-scaladoc/blog.md @@ -33,9 +33,9 @@ Scaladoc loads blog if the `_blog` directory exists. All the blogpost filenames should start with date in numeric format matching `YYYY-MM-DD`. Example name is `2015-10-23-dotty-compiler-bootstraps.md`. -## Structure +## Page metadata -When creating a blog page, you will have a first part to fill in with different fields. See the following example: +The blog pages in scaladoc support [Yaml Frontmatter](https://assemble.io/docs/YAML-front-matter.html) which allows you to specify different values which will be used for metadata in your page. Here are the possible fields: ``` --- @@ -43,19 +43,25 @@ layout: <A reference to the layout page for the blog page> author: <Name of the author of the page> title: <Title of the page> subTitle: <Subtitle of the page> -excerpt_separator: <!--more--> -date: <Date of the creation of the page> +date: <Date of the creation of the page>, e.g. 2016-12-05 authorImg: <Link to the author's image> --- -<Content> +<Content of your page> ``` +<!-- Here is an example of a blogpost page with the fields: +![Blog page](https://assets.digitalocean.com/articles/alligator/boo.svg "Scaladoc blog page") --> + ## Special characters for the content -` ```<content>``` ` : For code +` ```<content>``` ` : Multiline code block +You can also specify a language type. +` ```scala <content>``` ` + +`# Title` : For titles `## Subtitle` : For subtitles -`word` : To highlight +`word` : For inline code. `[word](Link to a website)`: If you want to put a link in a word \ No newline at end of file From 2fbf7171c7fae0b7228eab15ac19d7fa0b0a8ea6 Mon Sep 17 00:00:00 2001 From: Lucas <leblanc.lucas29@gmail.com> Date: Thu, 2 Mar 2023 14:55:44 +0100 Subject: [PATCH 4/8] Correction --- _overviews/scala3-scaladoc/blog.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/_overviews/scala3-scaladoc/blog.md b/_overviews/scala3-scaladoc/blog.md index 2f6b6b0f68..6d04cbd889 100644 --- a/_overviews/scala3-scaladoc/blog.md +++ b/_overviews/scala3-scaladoc/blog.md @@ -55,8 +55,7 @@ authorImg: <Link to the author's image> ## Special characters for the content ` ```<content>``` ` : Multiline code block -You can also specify a language type. -` ```scala <content>``` ` +You can also specify a language type, ` ```scala <content>``` ` `# Title` : For titles From 41a99c236a16140e2207d139f102ad9288bbd5cd Mon Sep 17 00:00:00 2001 From: Lucas <leblanc.lucas29@gmail.com> Date: Mon, 6 Mar 2023 10:14:17 +0100 Subject: [PATCH 5/8] Delete comment --- _overviews/scala3-scaladoc/blog.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/_overviews/scala3-scaladoc/blog.md b/_overviews/scala3-scaladoc/blog.md index 6d04cbd889..72175b09bf 100644 --- a/_overviews/scala3-scaladoc/blog.md +++ b/_overviews/scala3-scaladoc/blog.md @@ -49,9 +49,6 @@ authorImg: <Link to the author's image> <Content of your page> ``` -<!-- Here is an example of a blogpost page with the fields: -![Blog page](https://assets.digitalocean.com/articles/alligator/boo.svg "Scaladoc blog page") --> - ## Special characters for the content ` ```<content>``` ` : Multiline code block From 6e89d610128a6686fec9421b6818d4edec838bce Mon Sep 17 00:00:00 2001 From: Lucas <leblanc.lucas29@gmail.com> Date: Mon, 6 Mar 2023 11:19:15 +0100 Subject: [PATCH 6/8] Corrections of some nits Corrections of some nits Correction of nits Corrections text correction --- _overviews/scala3-scaladoc/blog.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/_overviews/scala3-scaladoc/blog.md b/_overviews/scala3-scaladoc/blog.md index 72175b09bf..ca822c10d5 100644 --- a/_overviews/scala3-scaladoc/blog.md +++ b/_overviews/scala3-scaladoc/blog.md @@ -50,14 +50,16 @@ authorImg: <Link to the author's image> ``` ## Special characters for the content +Keep in mind that the writing of your blog `<content>` is done with regular markdowns but here are some useful examples: -` ```<content>``` ` : Multiline code block -You can also specify a language type, ` ```scala <content>``` ` +` ```<content>``` ` : Multiline code block. -`# Title` : For titles +You can also specify a language type, ` ```scala <content>``` `. -`## Subtitle` : For subtitles +`# Title` : For titles. + +`## Subtitle` : For subtitles. `word` : For inline code. -`[word](Link to a website)`: If you want to put a link in a word \ No newline at end of file +`[name](Link to a website)`: If you want to put a link in the word. \ No newline at end of file From 5b5ebe9232a5b53b12d75cec296c0738667e93ed Mon Sep 17 00:00:00 2001 From: Lucas <leblanc.lucas29@gmail.com> Date: Sat, 11 Mar 2023 19:44:57 +0100 Subject: [PATCH 7/8] Change the sentence line 53 --- _overviews/scala3-scaladoc/blog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_overviews/scala3-scaladoc/blog.md b/_overviews/scala3-scaladoc/blog.md index ca822c10d5..afcf00738e 100644 --- a/_overviews/scala3-scaladoc/blog.md +++ b/_overviews/scala3-scaladoc/blog.md @@ -50,7 +50,7 @@ authorImg: <Link to the author's image> ``` ## Special characters for the content -Keep in mind that the writing of your blog `<content>` is done with regular markdowns but here are some useful examples: +Keep in mind that the writing of your blog is done with classic markdown. So here are some useful examples: ` ```<content>``` ` : Multiline code block. From 5a671d1c983ceff7db268ee8d0ca5cfc257883de Mon Sep 17 00:00:00 2001 From: Lucas <leblanc.lucas29@gmail.com> Date: Mon, 13 Mar 2023 17:47:27 +0100 Subject: [PATCH 8/8] Remove examples in Special characters part --- _overviews/scala3-scaladoc/blog.md | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/_overviews/scala3-scaladoc/blog.md b/_overviews/scala3-scaladoc/blog.md index afcf00738e..9069c9900d 100644 --- a/_overviews/scala3-scaladoc/blog.md +++ b/_overviews/scala3-scaladoc/blog.md @@ -49,17 +49,7 @@ authorImg: <Link to the author's image> <Content of your page> ``` -## Special characters for the content -Keep in mind that the writing of your blog is done with classic markdown. So here are some useful examples: +You can also find more details about the front matter on the [Jekyll documentation site](https://jekyllrb.com/docs/front-matter/). -` ```<content>``` ` : Multiline code block. - -You can also specify a language type, ` ```scala <content>``` `. - -`# Title` : For titles. - -`## Subtitle` : For subtitles. - -`word` : For inline code. - -`[name](Link to a website)`: If you want to put a link in the word. \ No newline at end of file +## Syntax of the content +Keep in mind that the writing of your blog is done with Markdown. You can find more information about the syntax in [Markdown Guide](https://www.markdownguide.org/basic-syntax/).