Add page layouts functionality by jamos-tay · Pull Request #439 · MarkBind/markbind

jamos-tay · 2018-09-24T14:10:03Z

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [X] New feature

What is the rationale for this request?

Users may want to add the same footer/head to a group of files at once without having to specify it in each file's frontMatter individually.

What changes did you make? (Give an overview)

Follow up from this solution: #389 (comment)

This PR adds support for MarkBind themes (changed from 'templates' because that name was used by nunjucks).

A theme consists of 5 files, navigation.md, head.md, footer.md, styles.css, scripts.js. Themes are stored in the _markbind/themes folder, laid out like this:

// This one is created on markbind init with all blank files - basically no change
_markbind/themes/default/
navigation.md, head.md, footer.md, styles.css, scripts.js
_markbind/themes/themeA/
navigation.md, head.md, footer.md, styles.css, scripts.js
_markbind/themes/themeB/
navigation.md, head.md, footer.md, styles.css, scripts.js

Users can apply themes to a set of pages either through the site.json or the frontMatter:

// Theme A will be applied to all index.md files{"glob": "**/index.md","theme": "ThemeA"},// Theme B will be applied to index2.md{"src": "index2.md","theme": "ThemeB"},// No Theme - default theme will be applied{"src": "index3.md"},

<frontmatter>
theme: themeA <!-- Takes precedence over site.json -->
head: head.md <!-- Takes precedence over themeA's head.md -->
</frontmatter>

All files in the folder will be applied.

Is there anything you'd like reviewers to focus on?

The following use cases aren't supported:

Using default theme for certain files only: Overriding default theme overwrites all 5 files, so you can't have say default/head.md and myTheme/footer.md at the same time.
Additive applying of scripts and css: Should a theme's js and css overwrite the default, or should it apply both?

acjh · 2018-09-24T14:19:30Z

Themes are better reserved for styling, e.g. #386.

How about "layout"?

jamos-tay · 2018-09-25T09:50:45Z

Sure, layout is fine

yamgent · 2018-09-27T13:16:41Z

Also right now the tests only includes overriding the layout in site.json. We can write additional tests to the test site for overriding the individual component of the layout in the <frontmatter> as well, e.g.:

<frontmatter>
layout: layoutA
head: head.md
</frontmatter>

yamgent · 2018-09-27T13:22:12Z

Additive applying of scripts and css: Should a theme's js and css overwrite the default, or should it apply both?

This might result in several levels of css and js. It can go quite deep, making it hard for the user to control what should be included and what shouldn't be included.

The design can get quite complicated, but I think it is a feature certainty worth exploring in the future.

jamos-tay · 2018-09-28T10:45:12Z

Updated with fixes (+ additional test)

Sure, we can worry about that later

jamos-tay · 2018-09-28T13:26:43Z

Updated to resolve merge conflict

yamgent · 2018-09-28T13:31:09Z

 <link rel="stylesheet" href="..\markbind\css\bootstrap-glyphicons.min.css" >
 <link rel="stylesheet" href="..\markbind\css\github.min.css">
 <link rel="stylesheet" href="..\markbind\css\markbind.css">
+ <link rel="stylesheet" href="_markbind\layouts\default\styles.css">


I think it would be better to put these inside the markbind folder (no underscroll at the front) rather than inside the _markbind folder, because the _markbind folder has a connotation that it contains working files, rather than files for actual deployment.
Same thing for the JavaScript files.

Sure, moved it to the assets folder.
Also added path to ignore so they don't get copied to the _markbind folder

yamgent · 2018-10-05T13:13:34Z

+- `styles.css` : Contains custom styles
+- `scripts.js` : Contains custom javascript
+
+These files will be automatically appended to a page upon generation, allowing you to quickly apply styles to a batch of pages at once.


Seems to be repeating the same thing as The default layout is automatically applied to every single page. below?
Or do you mean it is generated when doing a markbind init?

I meant to advertise the use case, like the purpose of templates is to quickly apply stuff to a batch of files.
I moved the sentence up so it's a little clearer.

jamos-tay · 2018-10-10T08:14:42Z

Necessary changes made!

jamos-tay · 2018-09-24T14:10:03Z

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [X] New feature

Fixes#389

What is the rationale for this request?

Users may want to add the same footer/head to a group of files at once without having to specify it in each file's frontMatter individually.

What changes did you make? (Give an overview)

Follow up from this solution: #389 (comment)

This PR adds support for MarkBind themes (changed from 'templates' because that name was used by nunjucks).

A theme consists of 5 files, navigation.md, head.md, footer.md, styles.css, scripts.js. Themes are stored in the _markbind/themes folder, laid out like this:

// This one is created on markbind init with all blank files - basically no change
_markbind/themes/default/
navigation.md, head.md, footer.md, styles.css, scripts.js
_markbind/themes/themeA/
navigation.md, head.md, footer.md, styles.css, scripts.js
_markbind/themes/themeB/
navigation.md, head.md, footer.md, styles.css, scripts.js

Users can apply themes to a set of pages either through the site.json or the frontMatter:

// Theme A will be applied to all index.md files{"glob": "**/index.md","theme": "ThemeA"},// Theme B will be applied to index2.md{"src": "index2.md","theme": "ThemeB"},// No Theme - default theme will be applied{"src": "index3.md"},

<frontmatter>
theme: themeA <!-- Takes precedence over site.json -->
head: head.md <!-- Takes precedence over themeA's head.md -->
</frontmatter>

All files in the folder will be applied.

Is there anything you'd like reviewers to focus on?

The following use cases aren't supported:

Using default theme for certain files only: Overriding default theme overwrites all 5 files, so you can't have say default/head.md and myTheme/footer.md at the same time.
Additive applying of scripts and css: Should a theme's js and css overwrite the default, or should it apply both?

acjh · 2018-09-24T14:19:30Z

Themes are better reserved for styling, e.g. #386.

How about "layout"?

jamos-tay · 2018-09-25T09:50:45Z

Sure, layout is fine

yamgent · 2018-09-27T13:16:41Z

Also right now the tests only includes overriding the layout in site.json. We can write additional tests to the test site for overriding the individual component of the layout in the <frontmatter> as well, e.g.:

<frontmatter>
layout: layoutA
head: head.md
</frontmatter>

yamgent · 2018-09-27T13:22:12Z

Additive applying of scripts and css: Should a theme's js and css overwrite the default, or should it apply both?

This might result in several levels of css and js. It can go quite deep, making it hard for the user to control what should be included and what shouldn't be included.

The design can get quite complicated, but I think it is a feature certainty worth exploring in the future.

jamos-tay · 2018-09-28T10:45:12Z

Updated with fixes (+ additional test)

Sure, we can worry about that later

jamos-tay · 2018-09-28T13:26:43Z

Updated to resolve merge conflict

yamgent · 2018-09-28T13:31:09Z

 <link rel="stylesheet" href="..\markbind\css\bootstrap-glyphicons.min.css" >
 <link rel="stylesheet" href="..\markbind\css\github.min.css">
 <link rel="stylesheet" href="..\markbind\css\markbind.css">
+ <link rel="stylesheet" href="_markbind\layouts\default\styles.css">


I think it would be better to put these inside the markbind folder (no underscroll at the front) rather than inside the _markbind folder, because the _markbind folder has a connotation that it contains working files, rather than files for actual deployment.
Same thing for the JavaScript files.

Sure, moved it to the assets folder.
Also added path to ignore so they don't get copied to the _markbind folder

yamgent · 2018-10-05T13:13:34Z

+- `styles.css` : Contains custom styles
+- `scripts.js` : Contains custom javascript
+
+These files will be automatically appended to a page upon generation, allowing you to quickly apply styles to a batch of pages at once.


Seems to be repeating the same thing as The default layout is automatically applied to every single page. below?
Or do you mean it is generated when doing a markbind init?

I meant to advertise the use case, like the purpose of templates is to quickly apply stuff to a batch of files.
I moved the sentence up so it's a little clearer.

jamos-tay · 2018-10-10T08:14:42Z

Necessary changes made!

jamos-tay · 2018-09-24T14:10:03Z

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [X] New feature

Fixes#389

What is the rationale for this request?

Users may want to add the same footer/head to a group of files at once without having to specify it in each file's frontMatter individually.

What changes did you make? (Give an overview)

Follow up from this solution: #389 (comment)

This PR adds support for MarkBind themes (changed from 'templates' because that name was used by nunjucks).

A theme consists of 5 files, navigation.md, head.md, footer.md, styles.css, scripts.js. Themes are stored in the _markbind/themes folder, laid out like this:

// This one is created on markbind init with all blank files - basically no change
_markbind/themes/default/
navigation.md, head.md, footer.md, styles.css, scripts.js
_markbind/themes/themeA/
navigation.md, head.md, footer.md, styles.css, scripts.js
_markbind/themes/themeB/
navigation.md, head.md, footer.md, styles.css, scripts.js

Users can apply themes to a set of pages either through the site.json or the frontMatter:

// Theme A will be applied to all index.md files{"glob": "**/index.md","theme": "ThemeA"},// Theme B will be applied to index2.md{"src": "index2.md","theme": "ThemeB"},// No Theme - default theme will be applied{"src": "index3.md"},

<frontmatter>
theme: themeA <!-- Takes precedence over site.json -->
head: head.md <!-- Takes precedence over themeA's head.md -->
</frontmatter>

All files in the folder will be applied.

Is there anything you'd like reviewers to focus on?

The following use cases aren't supported:

Using default theme for certain files only: Overriding default theme overwrites all 5 files, so you can't have say default/head.md and myTheme/footer.md at the same time.
Additive applying of scripts and css: Should a theme's js and css overwrite the default, or should it apply both?

acjh · 2018-09-24T14:19:30Z

Themes are better reserved for styling, e.g. #386.

How about "layout"?

jamos-tay · 2018-09-25T09:50:45Z

Sure, layout is fine

yamgent · 2018-09-27T13:16:41Z

Also right now the tests only includes overriding the layout in site.json. We can write additional tests to the test site for overriding the individual component of the layout in the <frontmatter> as well, e.g.:

<frontmatter>
layout: layoutA
head: head.md
</frontmatter>

yamgent · 2018-09-27T13:22:12Z

Additive applying of scripts and css: Should a theme's js and css overwrite the default, or should it apply both?

This might result in several levels of css and js. It can go quite deep, making it hard for the user to control what should be included and what shouldn't be included.

The design can get quite complicated, but I think it is a feature certainty worth exploring in the future.

jamos-tay · 2018-09-28T10:45:12Z

Updated with fixes (+ additional test)

Sure, we can worry about that later

jamos-tay · 2018-09-28T13:26:43Z

Updated to resolve merge conflict

yamgent · 2018-09-28T13:31:09Z

 <link rel="stylesheet" href="..\markbind\css\bootstrap-glyphicons.min.css" >
 <link rel="stylesheet" href="..\markbind\css\github.min.css">
 <link rel="stylesheet" href="..\markbind\css\markbind.css">
+ <link rel="stylesheet" href="_markbind\layouts\default\styles.css">


I think it would be better to put these inside the markbind folder (no underscroll at the front) rather than inside the _markbind folder, because the _markbind folder has a connotation that it contains working files, rather than files for actual deployment.
Same thing for the JavaScript files.

Sure, moved it to the assets folder.
Also added path to ignore so they don't get copied to the _markbind folder

yamgent · 2018-10-05T13:13:34Z

+- `styles.css` : Contains custom styles
+- `scripts.js` : Contains custom javascript
+
+These files will be automatically appended to a page upon generation, allowing you to quickly apply styles to a batch of pages at once.


Seems to be repeating the same thing as The default layout is automatically applied to every single page. below?
Or do you mean it is generated when doing a markbind init?

I meant to advertise the use case, like the purpose of templates is to quickly apply stuff to a batch of files.
I moved the sentence up so it's a little clearer.

jamos-tay · 2018-10-10T08:14:42Z

Necessary changes made!

jamos-tay · 2018-09-24T14:10:03Z

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [X] New feature

Fixes#389

What is the rationale for this request?

Users may want to add the same footer/head to a group of files at once without having to specify it in each file's frontMatter individually.

What changes did you make? (Give an overview)

Follow up from this solution: #389 (comment)

This PR adds support for MarkBind themes (changed from 'templates' because that name was used by nunjucks).

A theme consists of 5 files, navigation.md, head.md, footer.md, styles.css, scripts.js. Themes are stored in the _markbind/themes folder, laid out like this:

// This one is created on markbind init with all blank files - basically no change
_markbind/themes/default/
navigation.md, head.md, footer.md, styles.css, scripts.js
_markbind/themes/themeA/
navigation.md, head.md, footer.md, styles.css, scripts.js
_markbind/themes/themeB/
navigation.md, head.md, footer.md, styles.css, scripts.js

Users can apply themes to a set of pages either through the site.json or the frontMatter:

// Theme A will be applied to all index.md files{"glob": "**/index.md","theme": "ThemeA"},// Theme B will be applied to index2.md{"src": "index2.md","theme": "ThemeB"},// No Theme - default theme will be applied{"src": "index3.md"},

<frontmatter>
theme: themeA <!-- Takes precedence over site.json -->
head: head.md <!-- Takes precedence over themeA's head.md -->
</frontmatter>

All files in the folder will be applied.

Is there anything you'd like reviewers to focus on?

The following use cases aren't supported:

Using default theme for certain files only: Overriding default theme overwrites all 5 files, so you can't have say default/head.md and myTheme/footer.md at the same time.
Additive applying of scripts and css: Should a theme's js and css overwrite the default, or should it apply both?

acjh · 2018-09-24T14:19:30Z

Themes are better reserved for styling, e.g. #386.

How about "layout"?

jamos-tay · 2018-09-25T09:50:45Z

Sure, layout is fine

yamgent · 2018-09-27T13:16:41Z

Also right now the tests only includes overriding the layout in site.json. We can write additional tests to the test site for overriding the individual component of the layout in the <frontmatter> as well, e.g.:

<frontmatter>
layout: layoutA
head: head.md
</frontmatter>

yamgent · 2018-09-27T13:22:12Z

Additive applying of scripts and css: Should a theme's js and css overwrite the default, or should it apply both?

This might result in several levels of css and js. It can go quite deep, making it hard for the user to control what should be included and what shouldn't be included.

The design can get quite complicated, but I think it is a feature certainty worth exploring in the future.

jamos-tay · 2018-09-28T10:45:12Z

Updated with fixes (+ additional test)

Sure, we can worry about that later

jamos-tay · 2018-09-28T13:26:43Z

Updated to resolve merge conflict

yamgent · 2018-09-28T13:31:09Z

 <link rel="stylesheet" href="..\markbind\css\bootstrap-glyphicons.min.css" >
 <link rel="stylesheet" href="..\markbind\css\github.min.css">
 <link rel="stylesheet" href="..\markbind\css\markbind.css">
+ <link rel="stylesheet" href="_markbind\layouts\default\styles.css">


I think it would be better to put these inside the markbind folder (no underscroll at the front) rather than inside the _markbind folder, because the _markbind folder has a connotation that it contains working files, rather than files for actual deployment.
Same thing for the JavaScript files.

Sure, moved it to the assets folder.
Also added path to ignore so they don't get copied to the _markbind folder

yamgent · 2018-10-05T13:13:34Z

+- `styles.css` : Contains custom styles
+- `scripts.js` : Contains custom javascript
+
+These files will be automatically appended to a page upon generation, allowing you to quickly apply styles to a batch of pages at once.


Seems to be repeating the same thing as The default layout is automatically applied to every single page. below?
Or do you mean it is generated when doing a markbind init?

I meant to advertise the use case, like the purpose of templates is to quickly apply stuff to a batch of files.
I moved the sentence up so it's a little clearer.

jamos-tay · 2018-10-10T08:14:42Z

Necessary changes made!

jamos-tay · 2018-09-24T14:10:03Z

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [X] New feature

Fixes#389

What is the rationale for this request?

Users may want to add the same footer/head to a group of files at once without having to specify it in each file's frontMatter individually.

What changes did you make? (Give an overview)

Follow up from this solution: #389 (comment)

This PR adds support for MarkBind themes (changed from 'templates' because that name was used by nunjucks).

A theme consists of 5 files, navigation.md, head.md, footer.md, styles.css, scripts.js. Themes are stored in the _markbind/themes folder, laid out like this:

// This one is created on markbind init with all blank files - basically no change
_markbind/themes/default/
navigation.md, head.md, footer.md, styles.css, scripts.js
_markbind/themes/themeA/
navigation.md, head.md, footer.md, styles.css, scripts.js
_markbind/themes/themeB/
navigation.md, head.md, footer.md, styles.css, scripts.js

Users can apply themes to a set of pages either through the site.json or the frontMatter:

// Theme A will be applied to all index.md files{"glob": "**/index.md","theme": "ThemeA"},// Theme B will be applied to index2.md{"src": "index2.md","theme": "ThemeB"},// No Theme - default theme will be applied{"src": "index3.md"},

<frontmatter>
theme: themeA <!-- Takes precedence over site.json -->
head: head.md <!-- Takes precedence over themeA's head.md -->
</frontmatter>

All files in the folder will be applied.

Is there anything you'd like reviewers to focus on?

The following use cases aren't supported:

Using default theme for certain files only: Overriding default theme overwrites all 5 files, so you can't have say default/head.md and myTheme/footer.md at the same time.
Additive applying of scripts and css: Should a theme's js and css overwrite the default, or should it apply both?

acjh · 2018-09-24T14:19:30Z

Themes are better reserved for styling, e.g. #386.

How about "layout"?

jamos-tay · 2018-09-25T09:50:45Z

Sure, layout is fine

yamgent · 2018-09-27T13:16:41Z

Also right now the tests only includes overriding the layout in site.json. We can write additional tests to the test site for overriding the individual component of the layout in the <frontmatter> as well, e.g.:

<frontmatter>
layout: layoutA
head: head.md
</frontmatter>

yamgent · 2018-09-27T13:22:12Z

Additive applying of scripts and css: Should a theme's js and css overwrite the default, or should it apply both?

This might result in several levels of css and js. It can go quite deep, making it hard for the user to control what should be included and what shouldn't be included.

The design can get quite complicated, but I think it is a feature certainty worth exploring in the future.

jamos-tay · 2018-09-28T10:45:12Z

Updated with fixes (+ additional test)

Sure, we can worry about that later

jamos-tay · 2018-09-28T13:26:43Z

Updated to resolve merge conflict

yamgent · 2018-09-28T13:31:09Z

 <link rel="stylesheet" href="..\markbind\css\bootstrap-glyphicons.min.css" >
 <link rel="stylesheet" href="..\markbind\css\github.min.css">
 <link rel="stylesheet" href="..\markbind\css\markbind.css">
+ <link rel="stylesheet" href="_markbind\layouts\default\styles.css">


I think it would be better to put these inside the markbind folder (no underscroll at the front) rather than inside the _markbind folder, because the _markbind folder has a connotation that it contains working files, rather than files for actual deployment.
Same thing for the JavaScript files.

Sure, moved it to the assets folder.
Also added path to ignore so they don't get copied to the _markbind folder

yamgent · 2018-10-05T13:13:34Z

+- `styles.css` : Contains custom styles
+- `scripts.js` : Contains custom javascript
+
+These files will be automatically appended to a page upon generation, allowing you to quickly apply styles to a batch of pages at once.


Seems to be repeating the same thing as The default layout is automatically applied to every single page. below?
Or do you mean it is generated when doing a markbind init?

I meant to advertise the use case, like the purpose of templates is to quickly apply stuff to a batch of files.
I moved the sentence up so it's a little clearer.

jamos-tay · 2018-10-10T08:14:42Z

Necessary changes made!

jamos-tay · 2018-09-24T14:10:03Z

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [X] New feature

Fixes#389

What is the rationale for this request?

Users may want to add the same footer/head to a group of files at once without having to specify it in each file's frontMatter individually.

What changes did you make? (Give an overview)

Follow up from this solution: #389 (comment)

This PR adds support for MarkBind themes (changed from 'templates' because that name was used by nunjucks).

A theme consists of 5 files, navigation.md, head.md, footer.md, styles.css, scripts.js. Themes are stored in the _markbind/themes folder, laid out like this:

// This one is created on markbind init with all blank files - basically no change
_markbind/themes/default/
navigation.md, head.md, footer.md, styles.css, scripts.js
_markbind/themes/themeA/
navigation.md, head.md, footer.md, styles.css, scripts.js
_markbind/themes/themeB/
navigation.md, head.md, footer.md, styles.css, scripts.js

Users can apply themes to a set of pages either through the site.json or the frontMatter:

// Theme A will be applied to all index.md files{"glob": "**/index.md","theme": "ThemeA"},// Theme B will be applied to index2.md{"src": "index2.md","theme": "ThemeB"},// No Theme - default theme will be applied{"src": "index3.md"},

<frontmatter>
theme: themeA <!-- Takes precedence over site.json -->
head: head.md <!-- Takes precedence over themeA's head.md -->
</frontmatter>

All files in the folder will be applied.

Is there anything you'd like reviewers to focus on?

The following use cases aren't supported:

Using default theme for certain files only: Overriding default theme overwrites all 5 files, so you can't have say default/head.md and myTheme/footer.md at the same time.
Additive applying of scripts and css: Should a theme's js and css overwrite the default, or should it apply both?

acjh · 2018-09-24T14:19:30Z

Themes are better reserved for styling, e.g. #386.

How about "layout"?

jamos-tay · 2018-09-25T09:50:45Z

Sure, layout is fine

yamgent · 2018-09-27T13:16:41Z

Also right now the tests only includes overriding the layout in site.json. We can write additional tests to the test site for overriding the individual component of the layout in the <frontmatter> as well, e.g.:

<frontmatter>
layout: layoutA
head: head.md
</frontmatter>

yamgent · 2018-09-27T13:22:12Z

Additive applying of scripts and css: Should a theme's js and css overwrite the default, or should it apply both?

This might result in several levels of css and js. It can go quite deep, making it hard for the user to control what should be included and what shouldn't be included.

The design can get quite complicated, but I think it is a feature certainty worth exploring in the future.

jamos-tay · 2018-09-28T10:45:12Z

Updated with fixes (+ additional test)

Sure, we can worry about that later

jamos-tay · 2018-09-28T13:26:43Z

Updated to resolve merge conflict

yamgent · 2018-09-28T13:31:09Z

 <link rel="stylesheet" href="..\markbind\css\bootstrap-glyphicons.min.css" >
 <link rel="stylesheet" href="..\markbind\css\github.min.css">
 <link rel="stylesheet" href="..\markbind\css\markbind.css">
+ <link rel="stylesheet" href="_markbind\layouts\default\styles.css">


I think it would be better to put these inside the markbind folder (no underscroll at the front) rather than inside the _markbind folder, because the _markbind folder has a connotation that it contains working files, rather than files for actual deployment.
Same thing for the JavaScript files.

Sure, moved it to the assets folder.
Also added path to ignore so they don't get copied to the _markbind folder

yamgent · 2018-10-05T13:13:34Z

+- `styles.css` : Contains custom styles
+- `scripts.js` : Contains custom javascript
+
+These files will be automatically appended to a page upon generation, allowing you to quickly apply styles to a batch of pages at once.


Seems to be repeating the same thing as The default layout is automatically applied to every single page. below?
Or do you mean it is generated when doing a markbind init?

I meant to advertise the use case, like the purpose of templates is to quickly apply stuff to a batch of files.
I moved the sentence up so it's a little clearer.

jamos-tay · 2018-10-10T08:14:42Z

Necessary changes made!

jamos-tay · 2018-09-24T14:10:03Z

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [X] New feature

Fixes#389

What is the rationale for this request?

Users may want to add the same footer/head to a group of files at once without having to specify it in each file's frontMatter individually.

What changes did you make? (Give an overview)

Follow up from this solution: #389 (comment)

This PR adds support for MarkBind themes (changed from 'templates' because that name was used by nunjucks).

A theme consists of 5 files, navigation.md, head.md, footer.md, styles.css, scripts.js. Themes are stored in the _markbind/themes folder, laid out like this:

// This one is created on markbind init with all blank files - basically no change
_markbind/themes/default/
navigation.md, head.md, footer.md, styles.css, scripts.js
_markbind/themes/themeA/
navigation.md, head.md, footer.md, styles.css, scripts.js
_markbind/themes/themeB/
navigation.md, head.md, footer.md, styles.css, scripts.js

Users can apply themes to a set of pages either through the site.json or the frontMatter:

// Theme A will be applied to all index.md files{"glob": "**/index.md","theme": "ThemeA"},// Theme B will be applied to index2.md{"src": "index2.md","theme": "ThemeB"},// No Theme - default theme will be applied{"src": "index3.md"},

<frontmatter>
theme: themeA <!-- Takes precedence over site.json -->
head: head.md <!-- Takes precedence over themeA's head.md -->
</frontmatter>

All files in the folder will be applied.

Is there anything you'd like reviewers to focus on?

The following use cases aren't supported:

Using default theme for certain files only: Overriding default theme overwrites all 5 files, so you can't have say default/head.md and myTheme/footer.md at the same time.
Additive applying of scripts and css: Should a theme's js and css overwrite the default, or should it apply both?

acjh · 2018-09-24T14:19:30Z

Themes are better reserved for styling, e.g. #386.

How about "layout"?

jamos-tay · 2018-09-25T09:50:45Z

Sure, layout is fine

yamgent · 2018-09-27T13:16:41Z

Also right now the tests only includes overriding the layout in site.json. We can write additional tests to the test site for overriding the individual component of the layout in the <frontmatter> as well, e.g.:

<frontmatter>
layout: layoutA
head: head.md
</frontmatter>

yamgent · 2018-09-27T13:22:12Z

Additive applying of scripts and css: Should a theme's js and css overwrite the default, or should it apply both?

This might result in several levels of css and js. It can go quite deep, making it hard for the user to control what should be included and what shouldn't be included.

The design can get quite complicated, but I think it is a feature certainty worth exploring in the future.

jamos-tay · 2018-09-28T10:45:12Z

Updated with fixes (+ additional test)

Sure, we can worry about that later

jamos-tay · 2018-09-28T13:26:43Z

Updated to resolve merge conflict

yamgent · 2018-09-28T13:31:09Z

 <link rel="stylesheet" href="..\markbind\css\bootstrap-glyphicons.min.css" >
 <link rel="stylesheet" href="..\markbind\css\github.min.css">
 <link rel="stylesheet" href="..\markbind\css\markbind.css">
+ <link rel="stylesheet" href="_markbind\layouts\default\styles.css">


I think it would be better to put these inside the markbind folder (no underscroll at the front) rather than inside the _markbind folder, because the _markbind folder has a connotation that it contains working files, rather than files for actual deployment.
Same thing for the JavaScript files.

Sure, moved it to the assets folder.
Also added path to ignore so they don't get copied to the _markbind folder

yamgent · 2018-10-05T13:13:34Z

+- `styles.css` : Contains custom styles
+- `scripts.js` : Contains custom javascript
+
+These files will be automatically appended to a page upon generation, allowing you to quickly apply styles to a batch of pages at once.


Seems to be repeating the same thing as The default layout is automatically applied to every single page. below?
Or do you mean it is generated when doing a markbind init?

I meant to advertise the use case, like the purpose of templates is to quickly apply stuff to a batch of files.
I moved the sentence up so it's a little clearer.

jamos-tay · 2018-10-10T08:14:42Z

Necessary changes made!

jamos-tay · 2018-09-24T14:10:03Z

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [X] New feature

Fixes#389

What is the rationale for this request?

Users may want to add the same footer/head to a group of files at once without having to specify it in each file's frontMatter individually.

What changes did you make? (Give an overview)

Follow up from this solution: #389 (comment)

This PR adds support for MarkBind themes (changed from 'templates' because that name was used by nunjucks).

A theme consists of 5 files, navigation.md, head.md, footer.md, styles.css, scripts.js. Themes are stored in the _markbind/themes folder, laid out like this:

// This one is created on markbind init with all blank files - basically no change
_markbind/themes/default/
navigation.md, head.md, footer.md, styles.css, scripts.js
_markbind/themes/themeA/
navigation.md, head.md, footer.md, styles.css, scripts.js
_markbind/themes/themeB/
navigation.md, head.md, footer.md, styles.css, scripts.js

Users can apply themes to a set of pages either through the site.json or the frontMatter:

// Theme A will be applied to all index.md files{"glob": "**/index.md","theme": "ThemeA"},// Theme B will be applied to index2.md{"src": "index2.md","theme": "ThemeB"},// No Theme - default theme will be applied{"src": "index3.md"},

<frontmatter>
theme: themeA <!-- Takes precedence over site.json -->
head: head.md <!-- Takes precedence over themeA's head.md -->
</frontmatter>

All files in the folder will be applied.

Is there anything you'd like reviewers to focus on?

The following use cases aren't supported:

Using default theme for certain files only: Overriding default theme overwrites all 5 files, so you can't have say default/head.md and myTheme/footer.md at the same time.
Additive applying of scripts and css: Should a theme's js and css overwrite the default, or should it apply both?

acjh · 2018-09-24T14:19:30Z

Themes are better reserved for styling, e.g. #386.

How about "layout"?

jamos-tay · 2018-09-25T09:50:45Z

Sure, layout is fine

yamgent · 2018-09-27T13:16:41Z

Also right now the tests only includes overriding the layout in site.json. We can write additional tests to the test site for overriding the individual component of the layout in the <frontmatter> as well, e.g.:

<frontmatter>
layout: layoutA
head: head.md
</frontmatter>

yamgent · 2018-09-27T13:22:12Z

Additive applying of scripts and css: Should a theme's js and css overwrite the default, or should it apply both?

This might result in several levels of css and js. It can go quite deep, making it hard for the user to control what should be included and what shouldn't be included.

The design can get quite complicated, but I think it is a feature certainty worth exploring in the future.

jamos-tay · 2018-09-28T10:45:12Z

Updated with fixes (+ additional test)

Sure, we can worry about that later

jamos-tay · 2018-09-28T13:26:43Z

Updated to resolve merge conflict

yamgent · 2018-09-28T13:31:09Z

 <link rel="stylesheet" href="..\markbind\css\bootstrap-glyphicons.min.css" >
 <link rel="stylesheet" href="..\markbind\css\github.min.css">
 <link rel="stylesheet" href="..\markbind\css\markbind.css">
+ <link rel="stylesheet" href="_markbind\layouts\default\styles.css">


I think it would be better to put these inside the markbind folder (no underscroll at the front) rather than inside the _markbind folder, because the _markbind folder has a connotation that it contains working files, rather than files for actual deployment.
Same thing for the JavaScript files.

Sure, moved it to the assets folder.
Also added path to ignore so they don't get copied to the _markbind folder

yamgent · 2018-10-05T13:13:34Z

+- `styles.css` : Contains custom styles
+- `scripts.js` : Contains custom javascript
+
+These files will be automatically appended to a page upon generation, allowing you to quickly apply styles to a batch of pages at once.


Seems to be repeating the same thing as The default layout is automatically applied to every single page. below?
Or do you mean it is generated when doing a markbind init?

I meant to advertise the use case, like the purpose of templates is to quickly apply stuff to a batch of files.
I moved the sentence up so it's a little clearer.

jamos-tay · 2018-10-10T08:14:42Z

Necessary changes made!

jamos-tay changed the title ~~Add page themes functionality~~Add page layouts functionalitySep 25, 2018

jamos-tay force-pushed the add-templates branch from d9587b0 to 7c4f63fCompare September 25, 2018 09:52

yamgent reviewed Sep 27, 2018
View reviewed changes

Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threadlib/Page.js
Comment threadlib/Page.js Outdated

jamos-tay force-pushed the add-templates branch from d6438ac to d38b4c9Compare September 28, 2018 13:26

Add layouts functionality
750baae

jamos-tay force-pushed the add-templates branch from d38b4c9 to 750baaeCompare September 28, 2018 13:33

yamgent reviewed Sep 28, 2018
View reviewed changes

Move layouts to assets folder
b3b4329

jamos-tay force-pushed the add-templates branch from ffd8213 to b3b4329Compare September 30, 2018 16:58

Backwards compatibility issue with sites missing layout folder
9d2ec85

yamgent reviewed Oct 5, 2018
View reviewed changes

Fix bugs
0fb31b8

yamgent approved these changes Oct 20, 2018
View reviewed changes

yamgent added this to the v1.13.1 milestone Oct 20, 2018

yamgent merged commit 63a07c7 into MarkBind:masterOct 21, 2018

jamos-tay changed the title ~~Add page themes functionality~~Add page layouts functionalitySep 25, 2018

jamos-tay force-pushed the add-templates branch from d9587b0 to 7c4f63fCompare September 25, 2018 09:52

yamgent reviewed Sep 27, 2018
View reviewed changes

Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threadlib/Page.js
Comment threadlib/Page.js Outdated

jamos-tay force-pushed the add-templates branch from d6438ac to d38b4c9Compare September 28, 2018 13:26

Add layouts functionality
750baae

jamos-tay force-pushed the add-templates branch from d38b4c9 to 750baaeCompare September 28, 2018 13:33

yamgent reviewed Sep 28, 2018
View reviewed changes

Move layouts to assets folder
b3b4329

jamos-tay force-pushed the add-templates branch from ffd8213 to b3b4329Compare September 30, 2018 16:58

Backwards compatibility issue with sites missing layout folder
9d2ec85

yamgent reviewed Oct 5, 2018
View reviewed changes

Fix bugs
0fb31b8

yamgent approved these changes Oct 20, 2018
View reviewed changes

yamgent added this to the v1.13.1 milestone Oct 20, 2018

yamgent merged commit 63a07c7 into MarkBind:masterOct 21, 2018

jamos-tay changed the title ~~Add page themes functionality~~Add page layouts functionalitySep 25, 2018

jamos-tay force-pushed the add-templates branch from d9587b0 to 7c4f63fCompare September 25, 2018 09:52

yamgent reviewed Sep 27, 2018
View reviewed changes

Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threadlib/Page.js
Comment threadlib/Page.js Outdated

jamos-tay force-pushed the add-templates branch from d6438ac to d38b4c9Compare September 28, 2018 13:26

Add layouts functionality
750baae

jamos-tay force-pushed the add-templates branch from d38b4c9 to 750baaeCompare September 28, 2018 13:33

yamgent reviewed Sep 28, 2018
View reviewed changes

Move layouts to assets folder
b3b4329

jamos-tay force-pushed the add-templates branch from ffd8213 to b3b4329Compare September 30, 2018 16:58

Backwards compatibility issue with sites missing layout folder
9d2ec85

yamgent reviewed Oct 5, 2018
View reviewed changes

Fix bugs
0fb31b8

yamgent approved these changes Oct 20, 2018
View reviewed changes

yamgent added this to the v1.13.1 milestone Oct 20, 2018

yamgent merged commit 63a07c7 into MarkBind:masterOct 21, 2018

jamos-tay changed the title ~~Add page themes functionality~~Add page layouts functionalitySep 25, 2018

jamos-tay force-pushed the add-templates branch from d9587b0 to 7c4f63fCompare September 25, 2018 09:52

yamgent reviewed Sep 27, 2018
View reviewed changes

Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threadlib/Page.js
Comment threadlib/Page.js Outdated

jamos-tay force-pushed the add-templates branch from d6438ac to d38b4c9Compare September 28, 2018 13:26

Add layouts functionality
750baae

jamos-tay force-pushed the add-templates branch from d38b4c9 to 750baaeCompare September 28, 2018 13:33

yamgent reviewed Sep 28, 2018
View reviewed changes

Move layouts to assets folder
b3b4329

jamos-tay force-pushed the add-templates branch from ffd8213 to b3b4329Compare September 30, 2018 16:58

Backwards compatibility issue with sites missing layout folder
9d2ec85

yamgent reviewed Oct 5, 2018
View reviewed changes

Fix bugs
0fb31b8

yamgent approved these changes Oct 20, 2018
View reviewed changes

yamgent added this to the v1.13.1 milestone Oct 20, 2018

yamgent merged commit 63a07c7 into MarkBind:masterOct 21, 2018

jamos-tay changed the title ~~Add page themes functionality~~Add page layouts functionalitySep 25, 2018

jamos-tay force-pushed the add-templates branch from d9587b0 to 7c4f63fCompare September 25, 2018 09:52

yamgent reviewed Sep 27, 2018
View reviewed changes

Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threadlib/Page.js
Comment threadlib/Page.js Outdated

jamos-tay force-pushed the add-templates branch from d6438ac to d38b4c9Compare September 28, 2018 13:26

Add layouts functionality
750baae

jamos-tay force-pushed the add-templates branch from d38b4c9 to 750baaeCompare September 28, 2018 13:33

yamgent reviewed Sep 28, 2018
View reviewed changes

Move layouts to assets folder
b3b4329

jamos-tay force-pushed the add-templates branch from ffd8213 to b3b4329Compare September 30, 2018 16:58

Backwards compatibility issue with sites missing layout folder
9d2ec85

yamgent reviewed Oct 5, 2018
View reviewed changes

Fix bugs
0fb31b8

yamgent approved these changes Oct 20, 2018
View reviewed changes

yamgent added this to the v1.13.1 milestone Oct 20, 2018

yamgent merged commit 63a07c7 into MarkBind:masterOct 21, 2018

jamos-tay changed the title ~~Add page themes functionality~~Add page layouts functionalitySep 25, 2018

jamos-tay force-pushed the add-templates branch from d9587b0 to 7c4f63fCompare September 25, 2018 09:52

yamgent reviewed Sep 27, 2018
View reviewed changes

Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threadlib/Page.js
Comment threadlib/Page.js Outdated

jamos-tay force-pushed the add-templates branch from d6438ac to d38b4c9Compare September 28, 2018 13:26

Add layouts functionality
750baae

jamos-tay force-pushed the add-templates branch from d38b4c9 to 750baaeCompare September 28, 2018 13:33

yamgent reviewed Sep 28, 2018
View reviewed changes

Move layouts to assets folder
b3b4329

jamos-tay force-pushed the add-templates branch from ffd8213 to b3b4329Compare September 30, 2018 16:58

Backwards compatibility issue with sites missing layout folder
9d2ec85

yamgent reviewed Oct 5, 2018
View reviewed changes

Fix bugs
0fb31b8

yamgent approved these changes Oct 20, 2018
View reviewed changes

yamgent added this to the v1.13.1 milestone Oct 20, 2018

yamgent merged commit 63a07c7 into MarkBind:masterOct 21, 2018

jamos-tay changed the title ~~Add page themes functionality~~Add page layouts functionalitySep 25, 2018

jamos-tay force-pushed the add-templates branch from d9587b0 to 7c4f63fCompare September 25, 2018 09:52

yamgent reviewed Sep 27, 2018
View reviewed changes

Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threadlib/Page.js
Comment threadlib/Page.js Outdated

jamos-tay force-pushed the add-templates branch from d6438ac to d38b4c9Compare September 28, 2018 13:26

Add layouts functionality
750baae

jamos-tay force-pushed the add-templates branch from d38b4c9 to 750baaeCompare September 28, 2018 13:33

yamgent reviewed Sep 28, 2018
View reviewed changes

Move layouts to assets folder
b3b4329

jamos-tay force-pushed the add-templates branch from ffd8213 to b3b4329Compare September 30, 2018 16:58

Backwards compatibility issue with sites missing layout folder
9d2ec85

yamgent reviewed Oct 5, 2018
View reviewed changes

Fix bugs
0fb31b8

yamgent approved these changes Oct 20, 2018
View reviewed changes

yamgent added this to the v1.13.1 milestone Oct 20, 2018

yamgent merged commit 63a07c7 into MarkBind:masterOct 21, 2018

jamos-tay changed the title ~~Add page themes functionality~~Add page layouts functionalitySep 25, 2018

jamos-tay force-pushed the add-templates branch from d9587b0 to 7c4f63fCompare September 25, 2018 09:52

yamgent reviewed Sep 27, 2018
View reviewed changes

Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threaddocs/userGuide/contentAuthoring.md Outdated
Comment threadlib/Page.js
Comment threadlib/Page.js Outdated

jamos-tay force-pushed the add-templates branch from d6438ac to d38b4c9Compare September 28, 2018 13:26

Add layouts functionality
750baae

jamos-tay force-pushed the add-templates branch from d38b4c9 to 750baaeCompare September 28, 2018 13:33

yamgent reviewed Sep 28, 2018
View reviewed changes

Move layouts to assets folder
b3b4329

jamos-tay force-pushed the add-templates branch from ffd8213 to b3b4329Compare September 30, 2018 16:58

Backwards compatibility issue with sites missing layout folder
9d2ec85

yamgent reviewed Oct 5, 2018
View reviewed changes

Fix bugs
0fb31b8

yamgent approved these changes Oct 20, 2018
View reviewed changes

yamgent added this to the v1.13.1 milestone Oct 20, 2018

yamgent merged commit 63a07c7 into MarkBind:masterOct 21, 2018

Uh oh!

Conversation

jamos-tay commented Sep 24, 2018

Uh oh!

acjh commented Sep 24, 2018

Uh oh!

jamos-tay commented Sep 25, 2018• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yamgent commented Sep 27, 2018

Uh oh!

yamgent commented Sep 27, 2018

Uh oh!

jamos-tay commented Sep 28, 2018

Uh oh!

jamos-tay commented Sep 28, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jamos-tay commented Oct 10, 2018• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

jamos-tay commented Sep 24, 2018

Uh oh!

acjh commented Sep 24, 2018

Uh oh!

jamos-tay commented Sep 25, 2018• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yamgent commented Sep 27, 2018

Uh oh!

yamgent commented Sep 27, 2018

Uh oh!

jamos-tay commented Sep 28, 2018

Uh oh!

jamos-tay commented Sep 28, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jamos-tay commented Oct 10, 2018• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

jamos-tay commented Sep 25, 2018•
edited
Loading

jamos-tay commented Oct 10, 2018•
edited
Loading

jamos-tay commented Sep 25, 2018•
edited
Loading

jamos-tay commented Oct 10, 2018•
edited
Loading

jamos-tay commented Sep 25, 2018•
edited
Loading

jamos-tay commented Oct 10, 2018•
edited
Loading