From a707f53012b9179bcf91f16e1be16eabd6f54f1f Mon Sep 17 00:00:00 2001 From: jingting1412 Date: Mon, 29 Jan 2024 12:41:27 +0800 Subject: [PATCH 01/46] Add default files for template --- packages/core/template/portfolio/.gitignore | 23 +++ packages/core/template/portfolio/404.md | 7 + .../portfolio/_markbind/layouts/404.md | 1 + .../portfolio/_markbind/layouts/default.md | 55 +++++++ .../portfolio/_markbind/variables.json | 3 + .../template/portfolio/_markbind/variables.md | 4 + .../template/portfolio/contents/topic1.md | 9 ++ .../template/portfolio/contents/topic2.md | 9 ++ .../template/portfolio/contents/topic3a.md | 9 ++ .../template/portfolio/contents/topic3b.md | 9 ++ packages/core/template/portfolio/index.md | 77 ++++++++++ packages/core/template/portfolio/site.json | 28 ++++ .../template/portfolio/stylesheets/main.css | 136 ++++++++++++++++++ 13 files changed, 370 insertions(+) create mode 100644 packages/core/template/portfolio/.gitignore create mode 100644 packages/core/template/portfolio/404.md create mode 100644 packages/core/template/portfolio/_markbind/layouts/404.md create mode 100644 packages/core/template/portfolio/_markbind/layouts/default.md create mode 100644 packages/core/template/portfolio/_markbind/variables.json create mode 100644 packages/core/template/portfolio/_markbind/variables.md create mode 100644 packages/core/template/portfolio/contents/topic1.md create mode 100644 packages/core/template/portfolio/contents/topic2.md create mode 100644 packages/core/template/portfolio/contents/topic3a.md create mode 100644 packages/core/template/portfolio/contents/topic3b.md create mode 100755 packages/core/template/portfolio/index.md create mode 100755 packages/core/template/portfolio/site.json create mode 100644 packages/core/template/portfolio/stylesheets/main.css diff --git a/packages/core/template/portfolio/.gitignore b/packages/core/template/portfolio/.gitignore new file mode 100644 index 0000000000..abf44778d8 --- /dev/null +++ b/packages/core/template/portfolio/.gitignore @@ -0,0 +1,23 @@ +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* +lerna-debug.log* +_markbind/logs/ + +# Dependency directories +node_modules/ + +# Production +_site/ + +# Env +.env +.env.local + +# IDE configs +.vscode/ +.idea/* +*.iml \ No newline at end of file diff --git a/packages/core/template/portfolio/404.md b/packages/core/template/portfolio/404.md new file mode 100644 index 0000000000..019786884d --- /dev/null +++ b/packages/core/template/portfolio/404.md @@ -0,0 +1,7 @@ + + title: Page not found + layout: 404.md + + +->

404

<- +->

File not found
Click here to go back to the home page.

<- \ No newline at end of file diff --git a/packages/core/template/portfolio/_markbind/layouts/404.md b/packages/core/template/portfolio/_markbind/layouts/404.md new file mode 100644 index 0000000000..f5e54988e8 --- /dev/null +++ b/packages/core/template/portfolio/_markbind/layouts/404.md @@ -0,0 +1 @@ +
{{ content }}
\ No newline at end of file diff --git a/packages/core/template/portfolio/_markbind/layouts/default.md b/packages/core/template/portfolio/_markbind/layouts/default.md new file mode 100644 index 0000000000..2507ae479e --- /dev/null +++ b/packages/core/template/portfolio/_markbind/layouts/default.md @@ -0,0 +1,55 @@ + + + + +
+ + Your Logo +
  • Topic 1
  • +
  • Topic 2
  • + +
  • Topic 3a
  • +
  • Topic 3b
  • +
    +
  • + +
  • +
    +
    + +
    + +
    + + {{ content }} +
    + + +
    + + diff --git a/packages/core/template/portfolio/_markbind/variables.json b/packages/core/template/portfolio/_markbind/variables.json new file mode 100644 index 0000000000..04d0b977d3 --- /dev/null +++ b/packages/core/template/portfolio/_markbind/variables.json @@ -0,0 +1,3 @@ +{ + "jsonVariableExample": "Your variables can be defined here as well" +} \ No newline at end of file diff --git a/packages/core/template/portfolio/_markbind/variables.md b/packages/core/template/portfolio/_markbind/variables.md new file mode 100644 index 0000000000..4a19d29999 --- /dev/null +++ b/packages/core/template/portfolio/_markbind/variables.md @@ -0,0 +1,4 @@ + +To inject this HTML segment in your MarkBind files, use {{ example }} where you want to place it. +More generally, surround the segment's id with double curly braces. + \ No newline at end of file diff --git a/packages/core/template/portfolio/contents/topic1.md b/packages/core/template/portfolio/contents/topic1.md new file mode 100644 index 0000000000..3f28f03594 --- /dev/null +++ b/packages/core/template/portfolio/contents/topic1.md @@ -0,0 +1,9 @@ + + title: Topic 1 + + +
    + +# Topic 1 + +> This is a placeholder page - more content to be added. diff --git a/packages/core/template/portfolio/contents/topic2.md b/packages/core/template/portfolio/contents/topic2.md new file mode 100644 index 0000000000..f86f7be568 --- /dev/null +++ b/packages/core/template/portfolio/contents/topic2.md @@ -0,0 +1,9 @@ + + title: Topic 2 + + +
    + +# Topic 2 + +> This is a placeholder page - more content to be added. diff --git a/packages/core/template/portfolio/contents/topic3a.md b/packages/core/template/portfolio/contents/topic3a.md new file mode 100644 index 0000000000..90194da60a --- /dev/null +++ b/packages/core/template/portfolio/contents/topic3a.md @@ -0,0 +1,9 @@ + + title: Topic 3a + + +
    + +# Topic 3a + +> This is a placeholder page - more content to be added. diff --git a/packages/core/template/portfolio/contents/topic3b.md b/packages/core/template/portfolio/contents/topic3b.md new file mode 100644 index 0000000000..db7ba8e857 --- /dev/null +++ b/packages/core/template/portfolio/contents/topic3b.md @@ -0,0 +1,9 @@ + + title: Topic 3b + + +
    + +# Topic 3b + +> This is a placeholder page - more content to be added. diff --git a/packages/core/template/portfolio/index.md b/packages/core/template/portfolio/index.md new file mode 100755 index 0000000000..09177b769c --- /dev/null +++ b/packages/core/template/portfolio/index.md @@ -0,0 +1,77 @@ + + title: Home Page + layout: default.md + pageNav: 4 + pageNavTitle: "Topics" + + +
    + +
    +
    +

    Great!
    You've just initialized a MarkBind site.

    +

    Let's get started...

    +
    +
    + +--- + +## What just happened? + +You have just initialized a _default_ MarkBind site! It is equipped with a set of core features, including site and page navigation. Additionally, we have included some convenient links to our User Guide, to help you get started quickly and easily. + + + +If you were intending to convert an existing GitHub wiki or a docs folder into MarkBind, use the `--convert` flag instead. See User Guide: MarkBind in the Project Workflow for more information. + +If you want to start with a _minimal_ template instead, use the `--template` flag with the "minimal" option to initialize a minimal site instead of the default. See User Guide: Templates for more information. + + + +--- + +## Navigating this site + +This _default_ site comes pre-configured with the core Navigation components: a **siteNav**, a **pageNav**, a **NavBar**, and a **Search Bar**. To help you get started with the **siteNav**, we have included five dummy placeholder pages. The **NavBar** also comes with a placeholder slot for your custom Logo. + +--- + +## Guide to MarkBind + +To see the capability of MarkBind in action, feel free to take a look at some of the websites built using MarkBind on our Showcase page. + +For more information on how to work with MarkBind sites and to add content, refer to our comprehensive User Guide. + + + +If you are interested in contributing to MarkBind, you can refer to our Developer Guide as well! + + + + + +##### **User Guide: Authoring Contents** + +> Learn about the variety of syntax schemes, formats, and custom MarkBind components that you can use in your MarkBind site. + +More info in: _User Guide → Authoring Contents_ + +--- + +##### **User Guide: Working with Sites** + +> Learn how to modify site properties, apply themes, and enable/disable plugins for your MarkBind site. + +More info in: _User Guide → Working with Sites_ + +--- + +##### **User Guide: Full Syntax Reference** + +> Refer to our Full Syntax Reference page to find a specific feature or component that you want to use in your MarkBind site. + +More info in: _User Guide → Full Syntax Reference_ + + + +--- diff --git a/packages/core/template/portfolio/site.json b/packages/core/template/portfolio/site.json new file mode 100755 index 0000000000..eb1d757851 --- /dev/null +++ b/packages/core/template/portfolio/site.json @@ -0,0 +1,28 @@ +{ + "baseUrl": "", + "titlePrefix": "", + "titleSuffix": "", + "ignore": [ + "_markbind/layouts/*", + "_markbind/logs/*", + "_site/*", + "site.json", + "*.md", + "*.njk", + ".git/*", + ".gitignore", + "node_modules/*" + ], + "pagesExclude": ["node_modules/*"], + "pages": [ + { + "src": "index.md" + }, + { + "glob": ["**/index.md", "**/*.md"] + } + ], + "deploy": { + "message": "Site Update." + } +} diff --git a/packages/core/template/portfolio/stylesheets/main.css b/packages/core/template/portfolio/stylesheets/main.css new file mode 100644 index 0000000000..6b039d3f09 --- /dev/null +++ b/packages/core/template/portfolio/stylesheets/main.css @@ -0,0 +1,136 @@ +mark { + background-color: #ff0; + border-radius: 5px; + padding-top: 0; + padding-bottom: 0; +} + +.indented { + padding-left: 20px; +} + +.theme-card img { + width: 100%; +} + +/* Scrollbar */ + +.slim-scroll::-webkit-scrollbar { + width: 5px; +} + +.slim-scroll::-webkit-scrollbar-thumb { + background: #808080; + border-radius: 20px; +} + +.slim-scroll::-webkit-scrollbar-track { + background: transparent; + border-radius: 20px; +} + +.slim-scroll-blue::-webkit-scrollbar { + width: 5px; +} + +.slim-scroll-blue::-webkit-scrollbar-thumb { + background: #00b0ef; + border-radius: 20px; +} + +.slim-scroll-blue::-webkit-scrollbar-track { + background: transparent; + border-radius: 20px; +} + +/* Layout containers */ + +#flex-body { + display: flex; + flex: 1; + align-items: start; +} + +#content-wrapper { + flex: 1; + margin: 0 auto; + min-width: 0; + max-width: 1000px; + overflow-x: auto; + padding: 0.8rem 20px 0 20px; + transition: 0.4s; + -webkit-transition: 0.4s; +} + +#site-nav, +#page-nav { + display: flex; + flex-direction: column; + position: sticky; + top: var(--sticky-header-height); + flex: 0 0 auto; + max-width: 300px; + max-height: calc(100vh - var(--sticky-header-height)); + width: 300px; +} + +#site-nav { + border-right: 1px solid lightgrey; + padding-bottom: 20px; + z-index: 999; +} + +.site-nav-top { + margin: 0.8rem 0; + padding: 0 12px 12px 12px; +} + +.nav-component { + overflow-y: auto; +} + +#page-nav { + border-left: 1px solid lightgrey; +} + +@media screen and (max-width: 1299.98px) { + #page-nav { + display: none; + } +} + +/* Bootstrap medium(md) responsive breakpoint */ +@media screen and (max-width: 991.98px) { + #site-nav { + display: none; + } +} + +/* Bootstrap small(sm) responsive breakpoint */ +@media (max-width: 767.98px) { + .indented { + padding-left: 10px; + } + + #content-wrapper { + padding: 0 10px; + } +} + +/* Bootstrap extra small(xs) responsive breakpoint */ +@media screen and (max-width: 575.98px) { + #site-nav { + display: none; + } +} + +/* Hide site navigation when printing */ +@media print { + #site-nav { + display: none; + } + + #page-nav { + display: none; + } +} From e28ccbb59c99a0faad070098d6cbacd60d1ed34f Mon Sep 17 00:00:00 2001 From: jingting1412 Date: Fri, 2 Feb 2024 11:51:56 +0800 Subject: [PATCH 02/46] Basic structure --- .../template/portfolio/_markbind/layouts/default.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/core/template/portfolio/_markbind/layouts/default.md b/packages/core/template/portfolio/_markbind/layouts/default.md index 2507ae479e..cb1a205af1 100644 --- a/packages/core/template/portfolio/_markbind/layouts/default.md +++ b/packages/core/template/portfolio/_markbind/layouts/default.md @@ -4,12 +4,12 @@
    - Your Logo -
  • Topic 1
  • -
  • Topic 2
  • - -
  • Topic 3a
  • -
  • Topic 3b
  • + Your Name +
  • Experience
  • +
  • Skills
  • + +
  • Project1
  • +
  • Project2