Configure nunjucks to use working directory

[jamos-tay]

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

• [X] Bug fix

Fixes#678 (I think)

What is the rationale for this request?

I couldn't run markbind serve docs to serve the docs folder as it was giving me errors:

C:\Users\Jamos\Desktop\Markbind>markbind serve docs

I had to run it from inside the folder to work:

C:\Users\Jamos\Desktop\Markbind\docs>markbind serve

This is due to this line from #668, nunjucks tries to read the file path from the current working directory which differs based on where the command is executed:

{% from "userGuide/fullSyntaxReference.md" import syntax_topics as topics %}

What changes did you make? (Give an overview)

Configure nunjucks to use the rootpath so sites can be served outside their working directory.

[damithc]

This is a breaking change, right? Existing nunjucks code specifies import paths relative to the project root.

[Chng-Zhi-Xuan]

Proposal:
To handle the sub-sites, we can use the directory of the nearest site.json file (since a sub-site should have one) as the nunjucks.configure([directory]) or parse the directory during explicit calls of nunjucks.renderString([string],{path: [directory]}).

Have not tested if it works but maybe a step in the right direction?

[nicholaschuayunzhi]

parse the directory during explicit calls of nunjucks.renderString([string],{path: [directory]}

This could be quite expensive, perhaps we can pass an additional argument for the site's root?

Alternatively, we could render the string wrt to the current working file. For most of the calls this is saved in context.cwf. This is different from nunjucks default behaviour though.

[jamos-tay]

Hmm, what are the edge cases to consider? Haven't really tested any other cases, but it managed to fix the docs problem

[nicholaschuayunzhi]

Consider a sub site where it references a file (say variables.md) with nunjucks relative to its own root folder. If built on its own it will be fine.

However, If the sub site is recursively built by a outer site, it will not be able to find variables.md as nunjucks is looking for it wrt to the outer site's root folder.

[acjh]

We should handle that; we already do for {{ baseUrl }}.

[jamos-tay]

Hi, reviving this PR.

@nicholaschuayunzhi I tested it, and I think it seems to be working? Here are my steps:

Site/
subsite/
_markbind/
variables.md <= Variable added here
_site/
index.md <= References variable
_site/
_subsite/
index.html <= Check this
_markbind/
index.md

• Create an empty folder named Site, run markbind init
• Create a subsite folder, run markbind init
• Create a variable in the subsite project and have index.md reference it
• Run markbind serve inside the Site folder
• Check the index.html of the subsite that is built in the Site's _site folder

The variable seems to be loaded correctly.

[nicholaschuayunzhi]

Hi @jamos-tay, did you access the file via nunjucks, eg:
{% from '_markbind/variables.md' import variable %} ? This should be in the subsite and you build the site from the root site.

[jamos-tay]

@nicholaschuayunzhi I've changed it to concat the baseUrl, the following works for me:

(Same directory structure as before)

subsite/_markbind/variables.md

{% set n = 5 %}

subsite/index.md

{% from "_markbind/variables.md" import n %}
{{ n }}

Running markbind serve in the subsite folder compiles _site/index.html correctly, 5 is displayed
Running markbind serve in the site folder compiles _site/subsite/index.html correctly, 5 is displayed
Running markbind serve docs in the markbind folder serves docs correctly

Is this correct?

[jamos-tay]

Had to move this down for eslint because it references calculateNewBaseUrl, only lines 208-210 are added

[nicholaschuayunzhi]

Hi @jamos-tay was testing your case and it works which is great.

However, when you create an "outer" root_variables.md, and reference it in index.md from the root site, it won't work.

This is because when we will configure nunjucks for the sub site, we haven't called nunjucks#renderString for the outer site variables. So when nunjucks tries to render a variable in the root site we get this error: Error: template not found: root_variables.md. (our nunjucks path is already the sub site)

[damithc]

@openorclose see if this PR can be salvaged as some work has been done already. It would be a pity to let that go to waste, if it can be helped.

[ang-zeyu]

Closing this per #931 (comment)

[jamos-tay]

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

• [X] Bug fix

Fixes#678 (I think)

What is the rationale for this request?

I couldn't run markbind serve docs to serve the docs folder as it was giving me errors:

C:\Users\Jamos\Desktop\Markbind>markbind serve docs

I had to run it from inside the folder to work:

C:\Users\Jamos\Desktop\Markbind\docs>markbind serve

This is due to this line from #668, nunjucks tries to read the file path from the current working directory which differs based on where the command is executed:

{% from "userGuide/fullSyntaxReference.md" import syntax_topics as topics %}

What changes did you make? (Give an overview)

Configure nunjucks to use the rootpath so sites can be served outside their working directory.

[damithc]

This is a breaking change, right? Existing nunjucks code specifies import paths relative to the project root.

[Chng-Zhi-Xuan]

Proposal:
To handle the sub-sites, we can use the directory of the nearest site.json file (since a sub-site should have one) as the nunjucks.configure([directory]) or parse the directory during explicit calls of nunjucks.renderString([string],{path: [directory]}).

Have not tested if it works but maybe a step in the right direction?

[nicholaschuayunzhi]

parse the directory during explicit calls of nunjucks.renderString([string],{path: [directory]}

This could be quite expensive, perhaps we can pass an additional argument for the site's root?

Alternatively, we could render the string wrt to the current working file. For most of the calls this is saved in context.cwf. This is different from nunjucks default behaviour though.

[jamos-tay]

Hmm, what are the edge cases to consider? Haven't really tested any other cases, but it managed to fix the docs problem

[nicholaschuayunzhi]

Consider a sub site where it references a file (say variables.md) with nunjucks relative to its own root folder. If built on its own it will be fine.

However, If the sub site is recursively built by a outer site, it will not be able to find variables.md as nunjucks is looking for it wrt to the outer site's root folder.

[acjh]

We should handle that; we already do for {{ baseUrl }}.

[jamos-tay]

Hi, reviving this PR.

@nicholaschuayunzhi I tested it, and I think it seems to be working? Here are my steps:

Site/
subsite/
_markbind/
variables.md <= Variable added here
_site/
index.md <= References variable
_site/
_subsite/
index.html <= Check this
_markbind/
index.md

• Create an empty folder named Site, run markbind init
• Create a subsite folder, run markbind init
• Create a variable in the subsite project and have index.md reference it
• Run markbind serve inside the Site folder
• Check the index.html of the subsite that is built in the Site's _site folder

The variable seems to be loaded correctly.

[nicholaschuayunzhi]

Hi @jamos-tay, did you access the file via nunjucks, eg:
{% from '_markbind/variables.md' import variable %} ? This should be in the subsite and you build the site from the root site.

[jamos-tay]

@nicholaschuayunzhi I've changed it to concat the baseUrl, the following works for me:

(Same directory structure as before)

subsite/_markbind/variables.md

{% set n = 5 %}

subsite/index.md

{% from "_markbind/variables.md" import n %}
{{ n }}

Running markbind serve in the subsite folder compiles _site/index.html correctly, 5 is displayed
Running markbind serve in the site folder compiles _site/subsite/index.html correctly, 5 is displayed
Running markbind serve docs in the markbind folder serves docs correctly

Is this correct?

[jamos-tay]

Had to move this down for eslint because it references calculateNewBaseUrl, only lines 208-210 are added

[nicholaschuayunzhi]

Hi @jamos-tay was testing your case and it works which is great.

However, when you create an "outer" root_variables.md, and reference it in index.md from the root site, it won't work.

This is because when we will configure nunjucks for the sub site, we haven't called nunjucks#renderString for the outer site variables. So when nunjucks tries to render a variable in the root site we get this error: Error: template not found: root_variables.md. (our nunjucks path is already the sub site)

[damithc]

@openorclose see if this PR can be salvaged as some work has been done already. It would be a pity to let that go to waste, if it can be helped.

[ang-zeyu]

Closing this per #931 (comment)

[jamos-tay]

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

• [X] Bug fix

Fixes#678 (I think)

What is the rationale for this request?

I couldn't run markbind serve docs to serve the docs folder as it was giving me errors:

C:\Users\Jamos\Desktop\Markbind>markbind serve docs

I had to run it from inside the folder to work:

C:\Users\Jamos\Desktop\Markbind\docs>markbind serve

This is due to this line from #668, nunjucks tries to read the file path from the current working directory which differs based on where the command is executed:

{% from "userGuide/fullSyntaxReference.md" import syntax_topics as topics %}

What changes did you make? (Give an overview)

Configure nunjucks to use the rootpath so sites can be served outside their working directory.

[damithc]

This is a breaking change, right? Existing nunjucks code specifies import paths relative to the project root.

[Chng-Zhi-Xuan]

Proposal:
To handle the sub-sites, we can use the directory of the nearest site.json file (since a sub-site should have one) as the nunjucks.configure([directory]) or parse the directory during explicit calls of nunjucks.renderString([string],{path: [directory]}).

Have not tested if it works but maybe a step in the right direction?

[nicholaschuayunzhi]

parse the directory during explicit calls of nunjucks.renderString([string],{path: [directory]}

This could be quite expensive, perhaps we can pass an additional argument for the site's root?

Alternatively, we could render the string wrt to the current working file. For most of the calls this is saved in context.cwf. This is different from nunjucks default behaviour though.

[jamos-tay]

Hmm, what are the edge cases to consider? Haven't really tested any other cases, but it managed to fix the docs problem

[nicholaschuayunzhi]

Consider a sub site where it references a file (say variables.md) with nunjucks relative to its own root folder. If built on its own it will be fine.

However, If the sub site is recursively built by a outer site, it will not be able to find variables.md as nunjucks is looking for it wrt to the outer site's root folder.

[acjh]

We should handle that; we already do for {{ baseUrl }}.

[jamos-tay]

Hi, reviving this PR.

@nicholaschuayunzhi I tested it, and I think it seems to be working? Here are my steps:

Site/
subsite/
_markbind/
variables.md <= Variable added here
_site/
index.md <= References variable
_site/
_subsite/
index.html <= Check this
_markbind/
index.md

• Create an empty folder named Site, run markbind init
• Create a subsite folder, run markbind init
• Create a variable in the subsite project and have index.md reference it
• Run markbind serve inside the Site folder
• Check the index.html of the subsite that is built in the Site's _site folder

The variable seems to be loaded correctly.

[nicholaschuayunzhi]

Hi @jamos-tay, did you access the file via nunjucks, eg:
{% from '_markbind/variables.md' import variable %} ? This should be in the subsite and you build the site from the root site.

[jamos-tay]

@nicholaschuayunzhi I've changed it to concat the baseUrl, the following works for me:

(Same directory structure as before)

subsite/_markbind/variables.md

{% set n = 5 %}

subsite/index.md

{% from "_markbind/variables.md" import n %}
{{ n }}

Running markbind serve in the subsite folder compiles _site/index.html correctly, 5 is displayed
Running markbind serve in the site folder compiles _site/subsite/index.html correctly, 5 is displayed
Running markbind serve docs in the markbind folder serves docs correctly

Is this correct?

[jamos-tay]

Had to move this down for eslint because it references calculateNewBaseUrl, only lines 208-210 are added

[nicholaschuayunzhi]

Hi @jamos-tay was testing your case and it works which is great.

However, when you create an "outer" root_variables.md, and reference it in index.md from the root site, it won't work.

This is because when we will configure nunjucks for the sub site, we haven't called nunjucks#renderString for the outer site variables. So when nunjucks tries to render a variable in the root site we get this error: Error: template not found: root_variables.md. (our nunjucks path is already the sub site)

[damithc]

@openorclose see if this PR can be salvaged as some work has been done already. It would be a pity to let that go to waste, if it can be helped.

[ang-zeyu]

Closing this per #931 (comment)

[jamos-tay]

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

• [X] Bug fix

Fixes#678 (I think)

What is the rationale for this request?

I couldn't run markbind serve docs to serve the docs folder as it was giving me errors:

C:\Users\Jamos\Desktop\Markbind>markbind serve docs

I had to run it from inside the folder to work:

C:\Users\Jamos\Desktop\Markbind\docs>markbind serve

This is due to this line from #668, nunjucks tries to read the file path from the current working directory which differs based on where the command is executed:

{% from "userGuide/fullSyntaxReference.md" import syntax_topics as topics %}

What changes did you make? (Give an overview)

Configure nunjucks to use the rootpath so sites can be served outside their working directory.

[damithc]

This is a breaking change, right? Existing nunjucks code specifies import paths relative to the project root.

[Chng-Zhi-Xuan]

Proposal:
To handle the sub-sites, we can use the directory of the nearest site.json file (since a sub-site should have one) as the nunjucks.configure([directory]) or parse the directory during explicit calls of nunjucks.renderString([string],{path: [directory]}).

Have not tested if it works but maybe a step in the right direction?

[nicholaschuayunzhi]

parse the directory during explicit calls of nunjucks.renderString([string],{path: [directory]}

This could be quite expensive, perhaps we can pass an additional argument for the site's root?

Alternatively, we could render the string wrt to the current working file. For most of the calls this is saved in context.cwf. This is different from nunjucks default behaviour though.

[jamos-tay]

Hmm, what are the edge cases to consider? Haven't really tested any other cases, but it managed to fix the docs problem

[nicholaschuayunzhi]

Consider a sub site where it references a file (say variables.md) with nunjucks relative to its own root folder. If built on its own it will be fine.

However, If the sub site is recursively built by a outer site, it will not be able to find variables.md as nunjucks is looking for it wrt to the outer site's root folder.

[acjh]

We should handle that; we already do for {{ baseUrl }}.

[jamos-tay]

Hi, reviving this PR.

@nicholaschuayunzhi I tested it, and I think it seems to be working? Here are my steps:

Site/
subsite/
_markbind/
variables.md <= Variable added here
_site/
index.md <= References variable
_site/
_subsite/
index.html <= Check this
_markbind/
index.md

• Create an empty folder named Site, run markbind init
• Create a subsite folder, run markbind init
• Create a variable in the subsite project and have index.md reference it
• Run markbind serve inside the Site folder
• Check the index.html of the subsite that is built in the Site's _site folder

The variable seems to be loaded correctly.

[nicholaschuayunzhi]

Hi @jamos-tay, did you access the file via nunjucks, eg:
{% from '_markbind/variables.md' import variable %} ? This should be in the subsite and you build the site from the root site.

[jamos-tay]

@nicholaschuayunzhi I've changed it to concat the baseUrl, the following works for me:

(Same directory structure as before)

subsite/_markbind/variables.md

{% set n = 5 %}

subsite/index.md

{% from "_markbind/variables.md" import n %}
{{ n }}

Running markbind serve in the subsite folder compiles _site/index.html correctly, 5 is displayed
Running markbind serve in the site folder compiles _site/subsite/index.html correctly, 5 is displayed
Running markbind serve docs in the markbind folder serves docs correctly

Is this correct?

[jamos-tay]

Had to move this down for eslint because it references calculateNewBaseUrl, only lines 208-210 are added

[nicholaschuayunzhi]

Hi @jamos-tay was testing your case and it works which is great.

However, when you create an "outer" root_variables.md, and reference it in index.md from the root site, it won't work.

This is because when we will configure nunjucks for the sub site, we haven't called nunjucks#renderString for the outer site variables. So when nunjucks tries to render a variable in the root site we get this error: Error: template not found: root_variables.md. (our nunjucks path is already the sub site)

[damithc]

@openorclose see if this PR can be salvaged as some work has been done already. It would be a pity to let that go to waste, if it can be helped.

[ang-zeyu]

Closing this per #931 (comment)

[jamos-tay]

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

• [X] Bug fix

Fixes#678 (I think)

What is the rationale for this request?

I couldn't run markbind serve docs to serve the docs folder as it was giving me errors:

C:\Users\Jamos\Desktop\Markbind>markbind serve docs

I had to run it from inside the folder to work:

C:\Users\Jamos\Desktop\Markbind\docs>markbind serve

This is due to this line from #668, nunjucks tries to read the file path from the current working directory which differs based on where the command is executed:

{% from "userGuide/fullSyntaxReference.md" import syntax_topics as topics %}

What changes did you make? (Give an overview)

Configure nunjucks to use the rootpath so sites can be served outside their working directory.

[damithc]

This is a breaking change, right? Existing nunjucks code specifies import paths relative to the project root.

[Chng-Zhi-Xuan]

Proposal:
To handle the sub-sites, we can use the directory of the nearest site.json file (since a sub-site should have one) as the nunjucks.configure([directory]) or parse the directory during explicit calls of nunjucks.renderString([string],{path: [directory]}).

Have not tested if it works but maybe a step in the right direction?

[nicholaschuayunzhi]

parse the directory during explicit calls of nunjucks.renderString([string],{path: [directory]}

This could be quite expensive, perhaps we can pass an additional argument for the site's root?

Alternatively, we could render the string wrt to the current working file. For most of the calls this is saved in context.cwf. This is different from nunjucks default behaviour though.

[jamos-tay]

Hmm, what are the edge cases to consider? Haven't really tested any other cases, but it managed to fix the docs problem

[nicholaschuayunzhi]

Consider a sub site where it references a file (say variables.md) with nunjucks relative to its own root folder. If built on its own it will be fine.

However, If the sub site is recursively built by a outer site, it will not be able to find variables.md as nunjucks is looking for it wrt to the outer site's root folder.

[acjh]

We should handle that; we already do for {{ baseUrl }}.

[jamos-tay]

Hi, reviving this PR.

@nicholaschuayunzhi I tested it, and I think it seems to be working? Here are my steps:

Site/
subsite/
_markbind/
variables.md <= Variable added here
_site/
index.md <= References variable
_site/
_subsite/
index.html <= Check this
_markbind/
index.md

• Create an empty folder named Site, run markbind init
• Create a subsite folder, run markbind init
• Create a variable in the subsite project and have index.md reference it
• Run markbind serve inside the Site folder
• Check the index.html of the subsite that is built in the Site's _site folder

The variable seems to be loaded correctly.

[nicholaschuayunzhi]

Hi @jamos-tay, did you access the file via nunjucks, eg:
{% from '_markbind/variables.md' import variable %} ? This should be in the subsite and you build the site from the root site.

[jamos-tay]

@nicholaschuayunzhi I've changed it to concat the baseUrl, the following works for me:

(Same directory structure as before)

subsite/_markbind/variables.md

{% set n = 5 %}

subsite/index.md

{% from "_markbind/variables.md" import n %}
{{ n }}

Running markbind serve in the subsite folder compiles _site/index.html correctly, 5 is displayed
Running markbind serve in the site folder compiles _site/subsite/index.html correctly, 5 is displayed
Running markbind serve docs in the markbind folder serves docs correctly

Is this correct?

[jamos-tay]

Had to move this down for eslint because it references calculateNewBaseUrl, only lines 208-210 are added

[nicholaschuayunzhi]

Hi @jamos-tay was testing your case and it works which is great.

However, when you create an "outer" root_variables.md, and reference it in index.md from the root site, it won't work.

This is because when we will configure nunjucks for the sub site, we haven't called nunjucks#renderString for the outer site variables. So when nunjucks tries to render a variable in the root site we get this error: Error: template not found: root_variables.md. (our nunjucks path is already the sub site)

[damithc]

@openorclose see if this PR can be salvaged as some work has been done already. It would be a pity to let that go to waste, if it can be helped.

[ang-zeyu]

Closing this per #931 (comment)

[jamos-tay]

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

• [X] Bug fix

Fixes#678 (I think)

What is the rationale for this request?

I couldn't run markbind serve docs to serve the docs folder as it was giving me errors:

C:\Users\Jamos\Desktop\Markbind>markbind serve docs

I had to run it from inside the folder to work:

C:\Users\Jamos\Desktop\Markbind\docs>markbind serve

This is due to this line from #668, nunjucks tries to read the file path from the current working directory which differs based on where the command is executed:

{% from "userGuide/fullSyntaxReference.md" import syntax_topics as topics %}

What changes did you make? (Give an overview)

Configure nunjucks to use the rootpath so sites can be served outside their working directory.

[damithc]

This is a breaking change, right? Existing nunjucks code specifies import paths relative to the project root.

[Chng-Zhi-Xuan]

Proposal:
To handle the sub-sites, we can use the directory of the nearest site.json file (since a sub-site should have one) as the nunjucks.configure([directory]) or parse the directory during explicit calls of nunjucks.renderString([string],{path: [directory]}).

Have not tested if it works but maybe a step in the right direction?

[nicholaschuayunzhi]

parse the directory during explicit calls of nunjucks.renderString([string],{path: [directory]}

This could be quite expensive, perhaps we can pass an additional argument for the site's root?

Alternatively, we could render the string wrt to the current working file. For most of the calls this is saved in context.cwf. This is different from nunjucks default behaviour though.

[jamos-tay]

Hmm, what are the edge cases to consider? Haven't really tested any other cases, but it managed to fix the docs problem

[nicholaschuayunzhi]

Consider a sub site where it references a file (say variables.md) with nunjucks relative to its own root folder. If built on its own it will be fine.

However, If the sub site is recursively built by a outer site, it will not be able to find variables.md as nunjucks is looking for it wrt to the outer site's root folder.

[acjh]

We should handle that; we already do for {{ baseUrl }}.

[jamos-tay]

Hi, reviving this PR.

@nicholaschuayunzhi I tested it, and I think it seems to be working? Here are my steps:

Site/
subsite/
_markbind/
variables.md <= Variable added here
_site/
index.md <= References variable
_site/
_subsite/
index.html <= Check this
_markbind/
index.md

• Create an empty folder named Site, run markbind init
• Create a subsite folder, run markbind init
• Create a variable in the subsite project and have index.md reference it
• Run markbind serve inside the Site folder
• Check the index.html of the subsite that is built in the Site's _site folder

The variable seems to be loaded correctly.

[nicholaschuayunzhi]

Hi @jamos-tay, did you access the file via nunjucks, eg:
{% from '_markbind/variables.md' import variable %} ? This should be in the subsite and you build the site from the root site.

[jamos-tay]

@nicholaschuayunzhi I've changed it to concat the baseUrl, the following works for me:

(Same directory structure as before)

subsite/_markbind/variables.md

{% set n = 5 %}

subsite/index.md

{% from "_markbind/variables.md" import n %}
{{ n }}

Running markbind serve in the subsite folder compiles _site/index.html correctly, 5 is displayed
Running markbind serve in the site folder compiles _site/subsite/index.html correctly, 5 is displayed
Running markbind serve docs in the markbind folder serves docs correctly

Is this correct?

[jamos-tay]

Had to move this down for eslint because it references calculateNewBaseUrl, only lines 208-210 are added

[nicholaschuayunzhi]

Hi @jamos-tay was testing your case and it works which is great.

However, when you create an "outer" root_variables.md, and reference it in index.md from the root site, it won't work.

This is because when we will configure nunjucks for the sub site, we haven't called nunjucks#renderString for the outer site variables. So when nunjucks tries to render a variable in the root site we get this error: Error: template not found: root_variables.md. (our nunjucks path is already the sub site)

[damithc]

@openorclose see if this PR can be salvaged as some work has been done already. It would be a pity to let that go to waste, if it can be helped.

[ang-zeyu]

Closing this per #931 (comment)

[jamos-tay]

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

• [X] Bug fix

Fixes#678 (I think)

What is the rationale for this request?

I couldn't run markbind serve docs to serve the docs folder as it was giving me errors:

C:\Users\Jamos\Desktop\Markbind>markbind serve docs

I had to run it from inside the folder to work:

C:\Users\Jamos\Desktop\Markbind\docs>markbind serve

This is due to this line from #668, nunjucks tries to read the file path from the current working directory which differs based on where the command is executed:

{% from "userGuide/fullSyntaxReference.md" import syntax_topics as topics %}

What changes did you make? (Give an overview)

Configure nunjucks to use the rootpath so sites can be served outside their working directory.

[damithc]

This is a breaking change, right? Existing nunjucks code specifies import paths relative to the project root.

[Chng-Zhi-Xuan]

Proposal:
To handle the sub-sites, we can use the directory of the nearest site.json file (since a sub-site should have one) as the nunjucks.configure([directory]) or parse the directory during explicit calls of nunjucks.renderString([string],{path: [directory]}).

Have not tested if it works but maybe a step in the right direction?

[nicholaschuayunzhi]

parse the directory during explicit calls of nunjucks.renderString([string],{path: [directory]}

This could be quite expensive, perhaps we can pass an additional argument for the site's root?

Alternatively, we could render the string wrt to the current working file. For most of the calls this is saved in context.cwf. This is different from nunjucks default behaviour though.

[jamos-tay]

Hmm, what are the edge cases to consider? Haven't really tested any other cases, but it managed to fix the docs problem

[nicholaschuayunzhi]

Consider a sub site where it references a file (say variables.md) with nunjucks relative to its own root folder. If built on its own it will be fine.

However, If the sub site is recursively built by a outer site, it will not be able to find variables.md as nunjucks is looking for it wrt to the outer site's root folder.

[acjh]

We should handle that; we already do for {{ baseUrl }}.

[jamos-tay]

Hi, reviving this PR.

@nicholaschuayunzhi I tested it, and I think it seems to be working? Here are my steps:

Site/
subsite/
_markbind/
variables.md <= Variable added here
_site/
index.md <= References variable
_site/
_subsite/
index.html <= Check this
_markbind/
index.md

• Create an empty folder named Site, run markbind init
• Create a subsite folder, run markbind init
• Create a variable in the subsite project and have index.md reference it
• Run markbind serve inside the Site folder
• Check the index.html of the subsite that is built in the Site's _site folder

The variable seems to be loaded correctly.

[nicholaschuayunzhi]

Hi @jamos-tay, did you access the file via nunjucks, eg:
{% from '_markbind/variables.md' import variable %} ? This should be in the subsite and you build the site from the root site.

[jamos-tay]

@nicholaschuayunzhi I've changed it to concat the baseUrl, the following works for me:

(Same directory structure as before)

subsite/_markbind/variables.md

{% set n = 5 %}

subsite/index.md

{% from "_markbind/variables.md" import n %}
{{ n }}

Running markbind serve in the subsite folder compiles _site/index.html correctly, 5 is displayed
Running markbind serve in the site folder compiles _site/subsite/index.html correctly, 5 is displayed
Running markbind serve docs in the markbind folder serves docs correctly

Is this correct?

[jamos-tay]

Had to move this down for eslint because it references calculateNewBaseUrl, only lines 208-210 are added

[nicholaschuayunzhi]

Hi @jamos-tay was testing your case and it works which is great.

However, when you create an "outer" root_variables.md, and reference it in index.md from the root site, it won't work.

This is because when we will configure nunjucks for the sub site, we haven't called nunjucks#renderString for the outer site variables. So when nunjucks tries to render a variable in the root site we get this error: Error: template not found: root_variables.md. (our nunjucks path is already the sub site)

[damithc]

@openorclose see if this PR can be salvaged as some work has been done already. It would be a pity to let that go to waste, if it can be helped.

[ang-zeyu]

Closing this per #931 (comment)

[jamos-tay]

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

• [X] Bug fix

Fixes#678 (I think)

What is the rationale for this request?

I couldn't run markbind serve docs to serve the docs folder as it was giving me errors:

C:\Users\Jamos\Desktop\Markbind>markbind serve docs

I had to run it from inside the folder to work:

C:\Users\Jamos\Desktop\Markbind\docs>markbind serve

This is due to this line from #668, nunjucks tries to read the file path from the current working directory which differs based on where the command is executed:

{% from "userGuide/fullSyntaxReference.md" import syntax_topics as topics %}

What changes did you make? (Give an overview)

Configure nunjucks to use the rootpath so sites can be served outside their working directory.

[damithc]

This is a breaking change, right? Existing nunjucks code specifies import paths relative to the project root.

[Chng-Zhi-Xuan]

Proposal:
To handle the sub-sites, we can use the directory of the nearest site.json file (since a sub-site should have one) as the nunjucks.configure([directory]) or parse the directory during explicit calls of nunjucks.renderString([string],{path: [directory]}).

Have not tested if it works but maybe a step in the right direction?

[nicholaschuayunzhi]

parse the directory during explicit calls of nunjucks.renderString([string],{path: [directory]}

This could be quite expensive, perhaps we can pass an additional argument for the site's root?

Alternatively, we could render the string wrt to the current working file. For most of the calls this is saved in context.cwf. This is different from nunjucks default behaviour though.

[jamos-tay]

Hmm, what are the edge cases to consider? Haven't really tested any other cases, but it managed to fix the docs problem

[nicholaschuayunzhi]

Consider a sub site where it references a file (say variables.md) with nunjucks relative to its own root folder. If built on its own it will be fine.

However, If the sub site is recursively built by a outer site, it will not be able to find variables.md as nunjucks is looking for it wrt to the outer site's root folder.

[acjh]

We should handle that; we already do for {{ baseUrl }}.

[jamos-tay]

Hi, reviving this PR.

@nicholaschuayunzhi I tested it, and I think it seems to be working? Here are my steps:

Site/
subsite/
_markbind/
variables.md <= Variable added here
_site/
index.md <= References variable
_site/
_subsite/
index.html <= Check this
_markbind/
index.md

• Create an empty folder named Site, run markbind init
• Create a subsite folder, run markbind init
• Create a variable in the subsite project and have index.md reference it
• Run markbind serve inside the Site folder
• Check the index.html of the subsite that is built in the Site's _site folder

The variable seems to be loaded correctly.

[nicholaschuayunzhi]

Hi @jamos-tay, did you access the file via nunjucks, eg:
{% from '_markbind/variables.md' import variable %} ? This should be in the subsite and you build the site from the root site.

[jamos-tay]

@nicholaschuayunzhi I've changed it to concat the baseUrl, the following works for me:

(Same directory structure as before)

subsite/_markbind/variables.md

{% set n = 5 %}

subsite/index.md

{% from "_markbind/variables.md" import n %}
{{ n }}

Running markbind serve in the subsite folder compiles _site/index.html correctly, 5 is displayed
Running markbind serve in the site folder compiles _site/subsite/index.html correctly, 5 is displayed
Running markbind serve docs in the markbind folder serves docs correctly

Is this correct?

[jamos-tay]

Had to move this down for eslint because it references calculateNewBaseUrl, only lines 208-210 are added

[nicholaschuayunzhi]

Hi @jamos-tay was testing your case and it works which is great.

However, when you create an "outer" root_variables.md, and reference it in index.md from the root site, it won't work.

This is because when we will configure nunjucks for the sub site, we haven't called nunjucks#renderString for the outer site variables. So when nunjucks tries to render a variable in the root site we get this error: Error: template not found: root_variables.md. (our nunjucks path is already the sub site)

[damithc]

@openorclose see if this PR can be salvaged as some work has been done already. It would be a pity to let that go to waste, if it can be helped.

[ang-zeyu]

Closing this per #931 (comment)