diff --git a/README.md b/README.md index 4f425ac07ee7e5f28f443d9eb1fcfe4b8aa4497a..0a901256855d2d1b72f4587455661f1577bf8a5e 100644 --- a/README.md +++ b/README.md @@ -1,11 +1 @@ -# http://jamkit.pages.labranet.jamk.fi/project-templates/opf-core-template-v2/ - -Open project framework release 0.6 - -## This is the Core-repository - -Update link below according your front page URL! - -## Linkki suomenkieliseen etusivuun: - -* +Testing \ No newline at end of file diff --git a/documentation/00-Current-status/current-status.md b/docs/00-Current-status/current-status.md similarity index 100% rename from documentation/00-Current-status/current-status.md rename to docs/00-Current-status/current-status.md diff --git a/documentation/00-Current-status/issues-and-board.md b/docs/00-Current-status/issues-and-board.md similarity index 100% rename from documentation/00-Current-status/issues-and-board.md rename to docs/00-Current-status/issues-and-board.md diff --git a/docs/00.-Feature-showcase.md b/docs/00.-Feature-showcase.md new file mode 100644 index 0000000000000000000000000000000000000000..603e2e31fc6b14e81163ca298fb22d37bd8cbe28 --- /dev/null +++ b/docs/00.-Feature-showcase.md @@ -0,0 +1,133 @@ +--- +title: Feature showcase +--- + +There are a lot on neat features in mkdocs. Here is a small showcase of the features. + +For full list please see the [Material for MkDocs documentation](https://squidfunk.github.io/mkdocs-material/reference/abbreviations/). + +### Zoomable images + +Zoom images using LightGallery. + +=== "Example" +  +=== "Code" + ```markdown +  + ``` + +### UML with superfences + +This uses the mermaid syntax. See documentation from: [https://mermaid-js.github.io/mermaid/#/](https://mermaid-js.github.io/mermaid/#/) + +=== "Example" + ```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! + ``` +=== "Code" + ``` + ```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! + ``` + ``` + +### Admonitions + +**Supproted types** +note, seealso, abstract, summary, tldr, info, todo, tip, hint, important, success, check, done, question, help, faq, warning, caution, attention, failure, fail, missing, danger, error, bug, example, quote, cite + +**Normal** + +=== "Example" + !!! note "Note title" + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod + nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor + massa, nec semper lorem quam in massa. +=== "Code" + ```markdown + !!! note "Note title" + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod + nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor + massa, nec semper lorem quam in massa. + ``` + +**Collapsible blocks** + +=== "Example" + ??? warning "Warning title" + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod + nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor + massa, nec semper lorem quam in massa. +=== "Code" + ```markdown + ??? warning "Warning title" + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod + nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor + massa, nec semper lorem quam in massa. + ``` + +**Collapsible blocks (open by default)** + +Adding a `+` after `???` will render the block as open on page load: + +=== "Example" + ???+ warning "Warning title" + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod + nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor + massa, nec semper lorem quam in massa. + +=== "Code" + ```markdown + ???+ warning "Warning title" + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod + nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor + massa, nec semper lorem quam in massa. + ``` + +### Tasklists + +=== "Example" + - [X] item 1 + * [X] item A + * [ ] item B + more text + + [x] item a + + [ ] item b + + [x] item c + * [X] item C + - [ ] item 2 + - [ ] item 3 +=== "Code" + ``` + - [X] item 1 + * [X] item A + * [ ] item B + more text + + [x] item a + + [ ] item b + + [x] item c + * [X] item C + - [ ] item 2 + - [ ] item 3 + ``` \ No newline at end of file diff --git a/docs/01.-Suppots-folders/01.index.md b/docs/01.-Suppots-folders/01.index.md new file mode 100644 index 0000000000000000000000000000000000000000..d64ecfb35b7ca4b49ede47b1f650e1029bcdd271 --- /dev/null +++ b/docs/01.-Suppots-folders/01.index.md @@ -0,0 +1,20 @@ +--- +title: Im a document in subfolder +--- + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus maximus euismod interdum. Praesent non dapibus neque, non blandit nisl. Suspendisse pulvinar ligula quis suscipit molestie. Integer sapien arcu, sagittis sed dignissim quis, dictum quis odio. Proin urna neque, vulputate a mi vitae, scelerisque tristique felis. Nam commodo ligula blandit enim ornare, eget condimentum nulla pharetra. Fusce eget cursus neque. Aenean eleifend porttitor tellus a interdum. Nulla lacinia suscipit purus. + +### Here we have some code + +**In traditional JavaScript** +```javascript +var messages = document.getElementsByClassname('message'); +messages.forEach(function(message) { + message.className = message.className + " visible"; +}); +``` + +**With jQuery** (library) +```javascript +$('.message').addClass('visible'); +``` \ No newline at end of file diff --git a/docs/01.-Suppots-folders/02.second-document.md b/docs/01.-Suppots-folders/02.second-document.md new file mode 100644 index 0000000000000000000000000000000000000000..2a2e52613447fb3629217e868bf8c66c01ff7f6e --- /dev/null +++ b/docs/01.-Suppots-folders/02.second-document.md @@ -0,0 +1,13 @@ +--- +title: This is a second document +--- + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus maximus euismod interdum. Praesent non dapibus neque, non blandit nisl. Suspendisse pulvinar ligula quis suscipit molestie. Integer sapien arcu, sagittis sed dignissim quis, dictum quis odio. Proin urna neque, vulputate a mi vitae, scelerisque tristique felis. Nam commodo ligula blandit enim ornare, eget condimentum nulla pharetra. Fusce eget cursus neque. Aenean eleifend porttitor tellus a interdum. Nulla lacinia suscipit purus. + +### This is a header before image + +Morbi feugiat elit a orci porta pellentesque. Nulla facilisi. Proin sed purus sed leo pulvinar lacinia at et urna. Duis enim nibh, gravida eu eros ut, vulputate malesuada diam. **Curabitur sollicitudin porttitor urna**, sed pharetra ante eleifend a. Praesent faucibus libero sed tortor condimentum euismod at ut tellus. *Curabitur non congue ante*, pretium sagittis neque. Etiam ut urna et justo aliquam sagittis quis id ante. + + + +**Nice image subtext** \ No newline at end of file diff --git a/documentation/10-Project-management/communication-plan.md b/docs/10-Project-management/communication-plan.md similarity index 100% rename from documentation/10-Project-management/communication-plan.md rename to docs/10-Project-management/communication-plan.md diff --git a/documentation/10-Project-management/project-contract.md b/docs/10-Project-management/project-contract.md similarity index 100% rename from documentation/10-Project-management/project-contract.md rename to docs/10-Project-management/project-contract.md diff --git a/documentation/10-Project-management/project-end-report.md b/docs/10-Project-management/project-end-report.md similarity index 100% rename from documentation/10-Project-management/project-end-report.md rename to docs/10-Project-management/project-end-report.md diff --git a/documentation/10-Project-management/project-end-status.md b/docs/10-Project-management/project-end-status.md similarity index 100% rename from documentation/10-Project-management/project-end-status.md rename to docs/10-Project-management/project-end-status.md diff --git a/documentation/10-Project-management/project-plan.md b/docs/10-Project-management/project-plan.md similarity index 100% rename from documentation/10-Project-management/project-plan.md rename to docs/10-Project-management/project-plan.md diff --git a/documentation/10-Project-management/project-team.md b/docs/10-Project-management/project-team.md similarity index 100% rename from documentation/10-Project-management/project-team.md rename to docs/10-Project-management/project-team.md diff --git a/documentation/10-Project-management/risk-management.md b/docs/10-Project-management/risk-management.md similarity index 100% rename from documentation/10-Project-management/risk-management.md rename to docs/10-Project-management/risk-management.md diff --git a/documentation/10-Project-management/time-tracking.md b/docs/10-Project-management/time-tracking.md similarity index 100% rename from documentation/10-Project-management/time-tracking.md rename to docs/10-Project-management/time-tracking.md diff --git a/documentation/20-Requirement-management/attachements/.gitkeep b/docs/20-Requirement-management/attachements/.gitkeep similarity index 100% rename from documentation/20-Requirement-management/attachements/.gitkeep rename to docs/20-Requirement-management/attachements/.gitkeep diff --git a/documentation/20-Requirement-management/images/.gitkeep b/docs/20-Requirement-management/images/.gitkeep similarity index 100% rename from documentation/20-Requirement-management/images/.gitkeep rename to docs/20-Requirement-management/images/.gitkeep diff --git a/documentation/20-Requirement-management/key-requirements.md b/docs/20-Requirement-management/key-requirements.md similarity index 100% rename from documentation/20-Requirement-management/key-requirements.md rename to docs/20-Requirement-management/key-requirements.md diff --git a/documentation/20-Requirement-management/product-mindmap.md b/docs/20-Requirement-management/product-mindmap.md similarity index 100% rename from documentation/20-Requirement-management/product-mindmap.md rename to docs/20-Requirement-management/product-mindmap.md diff --git a/documentation/20-Requirement-management/requirement-specification.md b/docs/20-Requirement-management/requirement-specification.md similarity index 100% rename from documentation/20-Requirement-management/requirement-specification.md rename to docs/20-Requirement-management/requirement-specification.md diff --git a/documentation/20-Requirement-management/templates/pohja-hyvaksyntatesti.md b/docs/20-Requirement-management/templates/pohja-hyvaksyntatesti.md similarity index 100% rename from documentation/20-Requirement-management/templates/pohja-hyvaksyntatesti.md rename to docs/20-Requirement-management/templates/pohja-hyvaksyntatesti.md diff --git a/documentation/20-Requirement-management/templates/readme.txt b/docs/20-Requirement-management/templates/readme.txt similarity index 100% rename from documentation/20-Requirement-management/templates/readme.txt rename to docs/20-Requirement-management/templates/readme.txt diff --git a/documentation/20-Requirement-management/templates/template-acceptancetest.md b/docs/20-Requirement-management/templates/template-acceptancetest.md similarity index 100% rename from documentation/20-Requirement-management/templates/template-acceptancetest.md rename to docs/20-Requirement-management/templates/template-acceptancetest.md diff --git a/documentation/20-Requirement-management/templates/template-feature.md b/docs/20-Requirement-management/templates/template-feature.md similarity index 100% rename from documentation/20-Requirement-management/templates/template-feature.md rename to docs/20-Requirement-management/templates/template-feature.md diff --git a/documentation/20-Requirement-management/templates/template-profile.md b/docs/20-Requirement-management/templates/template-profile.md similarity index 100% rename from documentation/20-Requirement-management/templates/template-profile.md rename to docs/20-Requirement-management/templates/template-profile.md diff --git a/documentation/20-Requirement-management/templates/template-requirementlist.md b/docs/20-Requirement-management/templates/template-requirementlist.md similarity index 100% rename from documentation/20-Requirement-management/templates/template-requirementlist.md rename to docs/20-Requirement-management/templates/template-requirementlist.md diff --git a/documentation/20-Requirement-management/templates/template-statemachine.md b/docs/20-Requirement-management/templates/template-statemachine.md similarity index 100% rename from documentation/20-Requirement-management/templates/template-statemachine.md rename to docs/20-Requirement-management/templates/template-statemachine.md diff --git a/documentation/20-Requirement-management/templates/template-testcase-checklist.md b/docs/20-Requirement-management/templates/template-testcase-checklist.md similarity index 100% rename from documentation/20-Requirement-management/templates/template-testcase-checklist.md rename to docs/20-Requirement-management/templates/template-testcase-checklist.md diff --git a/documentation/20-Requirement-management/templates/template-testcase.md b/docs/20-Requirement-management/templates/template-testcase.md similarity index 100% rename from documentation/20-Requirement-management/templates/template-testcase.md rename to docs/20-Requirement-management/templates/template-testcase.md diff --git a/documentation/20-Requirement-management/templates/template-usecase.md b/docs/20-Requirement-management/templates/template-usecase.md similarity index 100% rename from documentation/20-Requirement-management/templates/template-usecase.md rename to docs/20-Requirement-management/templates/template-usecase.md diff --git a/documentation/30-Architecture-and-design/application-architecture.md b/docs/30-Architecture-and-design/application-architecture.md similarity index 100% rename from documentation/30-Architecture-and-design/application-architecture.md rename to docs/30-Architecture-and-design/application-architecture.md diff --git a/documentation/30-Architecture-and-design/design-specification.md b/docs/30-Architecture-and-design/design-specification.md similarity index 100% rename from documentation/30-Architecture-and-design/design-specification.md rename to docs/30-Architecture-and-design/design-specification.md diff --git a/documentation/30-Architecture-and-design/hardware-architecture.md b/docs/30-Architecture-and-design/hardware-architecture.md similarity index 100% rename from documentation/30-Architecture-and-design/hardware-architecture.md rename to docs/30-Architecture-and-design/hardware-architecture.md diff --git a/documentation/30-Architecture-and-design/software-architecture.md b/docs/30-Architecture-and-design/software-architecture.md similarity index 100% rename from documentation/30-Architecture-and-design/software-architecture.md rename to docs/30-Architecture-and-design/software-architecture.md diff --git a/documentation/30-Architecture-and-design/solution-architecture.md b/docs/30-Architecture-and-design/solution-architecture.md similarity index 100% rename from documentation/30-Architecture-and-design/solution-architecture.md rename to docs/30-Architecture-and-design/solution-architecture.md diff --git a/documentation/40-Release-management/release-plan.md b/docs/40-Release-management/release-plan.md similarity index 100% rename from documentation/40-Release-management/release-plan.md rename to docs/40-Release-management/release-plan.md diff --git a/documentation/50-Test-management/Exmple_of_test_case_pool.pdf b/docs/50-Test-management/Exmple_of_test_case_pool.pdf similarity index 100% rename from documentation/50-Test-management/Exmple_of_test_case_pool.pdf rename to docs/50-Test-management/Exmple_of_test_case_pool.pdf diff --git a/documentation/50-Test-management/mastertestplan.md b/docs/50-Test-management/mastertestplan.md similarity index 100% rename from documentation/50-Test-management/mastertestplan.md rename to docs/50-Test-management/mastertestplan.md diff --git a/documentation/50-Test-management/review-template.md b/docs/50-Test-management/review-template.md similarity index 100% rename from documentation/50-Test-management/review-template.md rename to docs/50-Test-management/review-template.md diff --git a/documentation/50-Test-management/template-testcase.md b/docs/50-Test-management/template-testcase.md similarity index 100% rename from documentation/50-Test-management/template-testcase.md rename to docs/50-Test-management/template-testcase.md diff --git a/documentation/50-Test-management/testcase.pdf b/docs/50-Test-management/testcase.pdf similarity index 100% rename from documentation/50-Test-management/testcase.pdf rename to docs/50-Test-management/testcase.pdf diff --git a/documentation/50-Test-management/testresults.md b/docs/50-Test-management/testresults.md similarity index 100% rename from documentation/50-Test-management/testresults.md rename to docs/50-Test-management/testresults.md diff --git a/documentation/60-Production/demo-feedback/tbd.m b/docs/60-Production/demo-feedback/tbd.m similarity index 100% rename from documentation/60-Production/demo-feedback/tbd.m rename to docs/60-Production/demo-feedback/tbd.m diff --git a/documentation/60-Production/demo-product/tbd.m b/docs/60-Production/demo-product/tbd.m similarity index 100% rename from documentation/60-Production/demo-product/tbd.m rename to docs/60-Production/demo-product/tbd.m diff --git a/documentation/60-Production/production-dashboard.md b/docs/60-Production/production-dashboard.md similarity index 100% rename from documentation/60-Production/production-dashboard.md rename to docs/60-Production/production-dashboard.md diff --git a/documentation/60-Production/service-description.md b/docs/60-Production/service-description.md similarity index 100% rename from documentation/60-Production/service-description.md rename to docs/60-Production/service-description.md diff --git a/documentation/60-Production/tbd.md b/docs/60-Production/tbd.md similarity index 100% rename from documentation/60-Production/tbd.md rename to docs/60-Production/tbd.md diff --git a/documentation/70-Sales-and-marketing/billing/tbd.m b/docs/70-Sales-and-marketing/billing/tbd.m similarity index 100% rename from documentation/70-Sales-and-marketing/billing/tbd.m rename to docs/70-Sales-and-marketing/billing/tbd.m diff --git a/documentation/70-Sales-and-marketing/marketing-plan.md b/docs/70-Sales-and-marketing/marketing-plan.md similarity index 100% rename from documentation/70-Sales-and-marketing/marketing-plan.md rename to docs/70-Sales-and-marketing/marketing-plan.md diff --git a/documentation/70-Sales-and-marketing/offers/.gitkeep b/docs/70-Sales-and-marketing/offers/.gitkeep similarity index 100% rename from documentation/70-Sales-and-marketing/offers/.gitkeep rename to docs/70-Sales-and-marketing/offers/.gitkeep diff --git a/documentation/70-Sales-and-marketing/offers/esimerkki-lasku.md b/docs/70-Sales-and-marketing/offers/esimerkki-lasku.md similarity index 100% rename from documentation/70-Sales-and-marketing/offers/esimerkki-lasku.md rename to docs/70-Sales-and-marketing/offers/esimerkki-lasku.md diff --git a/documentation/70-Sales-and-marketing/offers/esimerkki-lasku.pdf b/docs/70-Sales-and-marketing/offers/esimerkki-lasku.pdf similarity index 100% rename from documentation/70-Sales-and-marketing/offers/esimerkki-lasku.pdf rename to docs/70-Sales-and-marketing/offers/esimerkki-lasku.pdf diff --git a/documentation/70-Sales-and-marketing/offers/harjoitus-lasku.md b/docs/70-Sales-and-marketing/offers/harjoitus-lasku.md similarity index 100% rename from documentation/70-Sales-and-marketing/offers/harjoitus-lasku.md rename to docs/70-Sales-and-marketing/offers/harjoitus-lasku.md diff --git a/documentation/70-Sales-and-marketing/offers/invoice-template.md b/docs/70-Sales-and-marketing/offers/invoice-template.md similarity index 100% rename from documentation/70-Sales-and-marketing/offers/invoice-template.md rename to docs/70-Sales-and-marketing/offers/invoice-template.md diff --git a/documentation/70-Sales-and-marketing/offers/offer-template.md b/docs/70-Sales-and-marketing/offers/offer-template.md similarity index 100% rename from documentation/70-Sales-and-marketing/offers/offer-template.md rename to docs/70-Sales-and-marketing/offers/offer-template.md diff --git a/documentation/70-Sales-and-marketing/offers/tbd.md b/docs/70-Sales-and-marketing/offers/tbd.md similarity index 100% rename from documentation/70-Sales-and-marketing/offers/tbd.md rename to docs/70-Sales-and-marketing/offers/tbd.md diff --git a/documentation/80-Documents-and-reporting/material-from-outside/files.md b/docs/80-Documents-and-reporting/material-from-outside/files.md similarity index 100% rename from documentation/80-Documents-and-reporting/material-from-outside/files.md rename to docs/80-Documents-and-reporting/material-from-outside/files.md diff --git a/documentation/80-Documents-and-reporting/material-to-export/files.md b/docs/80-Documents-and-reporting/material-to-export/files.md similarity index 100% rename from documentation/80-Documents-and-reporting/material-to-export/files.md rename to docs/80-Documents-and-reporting/material-to-export/files.md diff --git a/documentation/80-Documents-and-reporting/user-guide.md b/docs/80-Documents-and-reporting/user-guide.md similarity index 100% rename from documentation/80-Documents-and-reporting/user-guide.md rename to docs/80-Documents-and-reporting/user-guide.md diff --git a/documentation/90-Quality/coding-guidelines.md b/docs/90-Quality/coding-guidelines.md similarity index 100% rename from documentation/90-Quality/coding-guidelines.md rename to docs/90-Quality/coding-guidelines.md diff --git a/documentation/90-Quality/lessons-learned.md b/docs/90-Quality/lessons-learned.md similarity index 100% rename from documentation/90-Quality/lessons-learned.md rename to docs/90-Quality/lessons-learned.md diff --git a/documentation/99-Library/link-collection.md b/docs/99-Library/link-collection.md similarity index 100% rename from documentation/99-Library/link-collection.md rename to docs/99-Library/link-collection.md diff --git a/docs/Markdown-Cheatsheet.md b/docs/Markdown-Cheatsheet.md new file mode 100644 index 0000000000000000000000000000000000000000..29584ac131824139819e952b867621aac1bb8ac8 --- /dev/null +++ b/docs/Markdown-Cheatsheet.md @@ -0,0 +1,358 @@ +--- +title: Markdown Cheat Sheet +--- + + + + +#### Table of Contents +[Headers](#headers) +[Emphasis](#emphasis) +[Lists](#lists) +[Links](#links) +[Images](#images) +[Code and Syntax Highlighting](#code-and-syntax-highlighting) +[Tables](#tables) +[Blockquotes](#blockquotes) +[Inline HTML](#inline-html) +[Horizontal Rule](#horizontal-rule) +[Line Breaks](#line-breaks) + +## Headers + +```no-highlight +# H1 +## H2 +### H3 +#### H4 +##### H5 +###### H6 + +Alternatively, for H1 and H2, an underline-ish style: + +Alt-H1 +====== + +Alt-H2 +------ +``` + +# H1 +## H2 +### H3 +#### H4 +##### H5 +###### H6 + +Alternatively, for H1 and H2, an underline-ish style: + +Alt-H1 +====== + +Alt-H2 +------ + + +## Emphasis + +```no-highlight +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.~~ +``` + +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.~~ + + + +## Lists + +```no-highlight +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. + + Some text that should be aligned with the above item. + +* Unordered list can use asterisks +- Or minuses ++ Or pluses +``` + +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. + + Some text that should be aligned with the above item. + +* Unordered list can use asterisks +- Or minuses ++ Or pluses + + +## Links + +There are two ways to create links. + +```no-highlight +[I'm an inline-style link](https://www.google.com) + +[I'm a reference-style link][Arbitrary case-insensitive reference text] + +[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 a reference-style link][Arbitrary case-insensitive reference text] + +[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 + +```no-highlight +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" +``` + +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" + + +## Code and Syntax Highlighting + +Code blocks are part of the Markdown spec, but syntax highlighting isn't. However, many renderers -- like Github's and *Markdown Here* -- support syntax highlighting. *Markdown Here* supports highlighting for dozens of languages (and not-really-languages, like diffs and HTTP headers); to see the complete list, and how to write the language names, see the [highlight.js demo page](http://softwaremaniacs.org/media/soft/highlight/test.html). + +```no-highlight +Inline `code` has `back-ticks around` it. +``` + +Inline `code` has `back-ticks around` it. + +Blocks of code are either fenced by lines with three back-ticks <code>```</code>, or are indented with four spaces. I recommend only using the fenced code blocks -- they're easier and only they support syntax highlighting. + +``` + ```javascript + var s = "JavaScript syntax highlighting"; + alert(s); + ``` + + ```python + s = "Python syntax highlighting" + print s + ``` + + ``` + No language indicated, so no syntax highlighting. + But let's throw in a <b>tag</b>. + ``` +``` + + +```javascript +var s = "JavaScript syntax highlighting"; +alert(s); +``` + +```python +s = "Python syntax highlighting" +print s +``` + +``` +No language indicated, so no syntax highlighting in Markdown Here (varies on Github). +But let's throw in a <b>tag</b>. +``` + +Again, to see what languages are available for highlighting, and how to write those language names, see the [highlight.js demo page](http://softwaremaniacs.org/media/soft/highlight/test.html). + + +## Tables + +Tables aren't part of the core Markdown spec, but they are part of GFM and *Markdown Here* supports them. They are an easy way of adding tables to your email -- a task that would otherwise require copy-pasting from another application. + +```no-highlight +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 | + +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 +``` + +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 | + +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 + + +## Blockquotes + +```no-highlight +> 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 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. + + +## Inline HTML + +You can also use raw HTML in your Markdown, and it'll mostly work pretty well. + +```no-highlight +<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 Rule + +``` +Three or more... + +--- + +Hyphens + +*** + +Asterisks + +___ + +Underscores +``` + +Three or more... + +--- + +Hyphens + +*** + +Asterisks + +___ + +Underscores + + +## Line Breaks + +My basic recommendation for learning how line breaks work is to experiment and discover -- hit <Enter> once (i.e., insert one newline), then hit it twice (i.e., insert two newlines), see what happens. You'll soon learn to get what you want. "Markdown Toggle" is your friend. + +Here are some things to try out: + +``` +Here's a line for us to start with. + +This line is separated from the one above by two newlines, so it will be a *separate paragraph*. + +This line is also a separate paragraph, but... +This line is only separated by a single newline, so it's a separate line in the *same paragraph*. +``` + +Here's a line for us to start with. + +This line is separated from the one above by two newlines, so it will be a *separate paragraph*. + +This line is also begins a separate paragraph, but... +This line is only separated by a single newline, so it's a separate line in the *same paragraph*. + diff --git a/docs/assets/extra.css b/docs/assets/extra.css new file mode 100644 index 0000000000000000000000000000000000000000..52957cd57420fbe89368a8005acb6b0aa06a6a82 --- /dev/null +++ b/docs/assets/extra.css @@ -0,0 +1,50 @@ +:root { + --md-primary-fg-color: #0d004c; + --md-primary-fg-color--light: #0d004c; + --md-primary-fg-color--dark: #0d004c; +} + +.md-typeset .codehilite pre { + white-space: pre-wrap; + margin: 30px 0px; +} + +.admonition > p { + font-size: 14px; +} + +.admonition > p > a { color: #2C00FF !important +} + +.nav-logo > img { + max-width: 100%; +} + +p > a { color: #2C00FF !important +} + +p > a:hover { color: #e2066f !important +} + +td > a { color: #2C00FF !important +} + +td > a:hover { color: #e2066f !important +} + +.md-header-nav__button.md-logo img, .md-header-nav__button.md-logo svg, +.md-nav__title .md-nav__button.md-logo img, .md-nav__title .md-nav__button.md-logo svg { + display: none; +} + +.md-nav__item .md-nav__link--active { + font-weight: bold; +} + +p > a { + color: #0d004c !important +} + +p > a:hover { + color: #e2066f !important +} \ No newline at end of file diff --git a/docs/assets/jamk_logo.png b/docs/assets/jamk_logo.png new file mode 100644 index 0000000000000000000000000000000000000000..178fe0ed67d8ea4a0587861f53f414965d6ccafc Binary files /dev/null and b/docs/assets/jamk_logo.png differ diff --git a/docs/assets/lg.js b/docs/assets/lg.js new file mode 100644 index 0000000000000000000000000000000000000000..e7be8505a221c5e1aac74cbfbb5a5226ce88e99f --- /dev/null +++ b/docs/assets/lg.js @@ -0,0 +1,3 @@ +window.addEventListener('load', () => { + $(".lightgallery").lightGallery(); +}, false ) \ No newline at end of file diff --git a/docs/images/example_image.jpg b/docs/images/example_image.jpg new file mode 100644 index 0000000000000000000000000000000000000000..547e7574a46beefc541611d60925dd3fbd2bc614 Binary files /dev/null and b/docs/images/example_image.jpg differ diff --git a/documentation/index.md b/docs/index.md similarity index 100% rename from documentation/index.md rename to docs/index.md diff --git a/mkdocs.yml b/mkdocs.yml index 75bc8f7c4c4e0252ebd2cb21515bd06abe9d08b5..b4677375c85a50114300745f456eaeaf3cbd4eee 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,27 +1,53 @@ -site_name: Open Project Framework (OPF 0.6) - project environment -site_url: http://open-project-framework.pages.labranet.jamk.fi/opf-virtual-company-v1/core/ +site_name: ABCD1234 - Example Course +site_url: http://jamkit.pages.labranet.jamk.fi/templates/mkdocs-jamk-themed +site_description: Example Course +site_author: Firstname Lastname / JAMK IT -site_author: NarsuMan - -docs_dir: dokumentit +docs_dir: docs site_dir: public markdown_extensions: - - plantuml-markdown: - server: http://www.plantuml.com/plantuml - - toc: - anchorlink: True - separator: "_" - - admonition - - tables - - sane_lists - - - + - toc: + baselevel: 1 + - admonition + - tables + - sane_lists + - codehilite + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_div_format + - pymdownx.details + - pymdownx.tabbed + - pymdownx.tasklist + - pymdownx.critic: + mode: view + - lightgallery theme: - name: 'material' - palette: - primary: 'cyan' - accent: 'cyan' - logo: - icon: 'assignment' + name: material + language: 'en' + history_buttons: false + article_nav_bottom: false + article_nav_top: false + custom_dir: overrides + palette: + scheme: default + font: + text: 'Sofia-Pro' + code: 'Roboto Mono' + logo: 'assets/jamk_logo.png' + features: + - instant +extra_css: + - assets/extra.css + - https://cdnjs.cloudflare.com/ajax/libs/lightgallery/1.7.3/css/lightgallery.min.css + - https://use.typekit.net/yom0dkv.css +extra_javascript: + - https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.min.js + - https://cdnjs.cloudflare.com/ajax/libs/lightgallery/1.7.3/js/lightgallery-all.js + - https://unpkg.com/mermaid@8.6.4/dist/mermaid.min.js + - assets/lg.js +google_analytics: + - 'google-analytics-code' + - 'auto' \ No newline at end of file diff --git a/overrides/partials/nav.html b/overrides/partials/nav.html new file mode 100644 index 0000000000000000000000000000000000000000..90b1a14c653e663033e85973fe1be9170d946d7d --- /dev/null +++ b/overrides/partials/nav.html @@ -0,0 +1,38 @@ +<!-- Main navigation --> +<nav + class="md-nav md-nav--primary" + aria-label="{{ lang.t('nav.title') }}" + data-md-level="0" +> +<!-- Site title --> +<div class="nav-logo"> + {% include "partials/logo.html" %} +</div> +<label class="md-nav__title" for="__drawer"> + <a + href="{{ config.site_url | default(nav.homepage.url, true) | url }}" + title="{{ config.site_name }}" + class="md-nav__button md-logo" + aria-label="{{ config.site_name }}" + > + {% include "partials/logo.html" %} + </a> + {{ config.site_name }} +</label> + + <!-- Repository containing source --> + {% if config.repo_url %} + <div class="md-nav__source"> + {% include "partials/source.html" %} + </div> + {% endif %} + + <!-- Render item list --> + <ul class="md-nav__list" data-md-scrollfix> + {% for nav_item in nav %} + {% set path = "nav-" + loop.index | string %} + {% set level = 1 %} + {% include "partials/nav-item.html" %} + {% endfor %} + </ul> +</nav> \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..76d70cfbaa7efdd05e21211c78a0b2e31da98640 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +pymdown-extensions +pygments +mkdocs-material \ No newline at end of file diff --git a/test.md b/test.md new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391