MarkBind / markbind

MarkBind is a tool for generating content-heavy websites from source files in Markdown format
https://markbind.org/
MIT License
135 stars 124 forks source link

Support 'Deploy on Netlify' #479

Closed damithc closed 4 years ago

damithc commented 5 years ago

We can support 'Deploy on Netlify' ability, as per https://www.netlify.com/docs/deploy-button/

Xenonym commented 5 years ago

Are we intending for the template to just simply be the contents of markbind init?

If so, this should be relatively straightforward, but the template repository should probably reside in MarkBind than in any one of our personal accounts.

damithc commented 5 years ago

Are we intending for the template to just simply be the contents of markbind init?

I guess so, at least for the moment, until we create better templates.

If so, this should be relatively straightforward, but the template repository should probably reside in MarkBind than in any one of our personal accounts.

Yes. Maybe create a proof of concept repo in your own account first?

Xenonym commented 5 years ago

I have created a boilerplate repository here.

Here's the Deploy to Netlify button for testing:

Deploy to Netlify

damithc commented 5 years ago

I have created a boilerplate repository here.

Good work @Xenonym. Let's resume this when we have implemented a better starter template. The current one is a bit sparse. We'll probably need to improve markbind init to create a better starter website and then we can reuse it for this purpose. I'll create an issue for that shortly -> #519

crphang commented 5 years ago

@damithc is the current starter sufficient to add this functionality?

damithc commented 5 years ago

@damithc is the current starter sufficient to add this functionality?

At one point I was contemplating a starter such as this https://github.com/MarkBind/init-typical

crphang commented 5 years ago

After #935 has been merged, the current default starter has been updated to: https://crphang.github.io/web/

Let me know if there are some bugs I need to patch on the current starter. I am currently working on supporting initialization with flags like --minimal templates as well.

damithc commented 5 years ago

Nice. Will take a look and get back to you soon.

damithc commented 5 years ago

Some suggestions: image

The tooltip should only be for the word tooltip.

Point topNav/siteNav links to a single placeholder page (currently, they give 404)

Enable search?

crphang commented 5 years ago

@damithc fixed made with PR https://github.com/MarkBind/markbind/pull/939.

You can view the changes at https://crphang.github.io/

damithc commented 5 years ago

Looks good @Crphang

crphang commented 5 years ago

@damithc Here's one of Deploy on Netlify supported: https://suspicious-mccarthy-2f6d3d.netlify.com/.

Currently I am hosting it on my own repository: https://github.com/Crphang/webrepo. Would it be good to create one to be hosted within Markbind account?

Some design decisions on repository: I added the markbind site within your_site to have a clear separation of concern between netlify dependencies for deployment (which our user should not care about going forward) and the actual content that the user should be focused on.

crphang commented 5 years ago

Going forward, I see this being very useful for enhancing Markbind templates feature:

image

This allows our users to quickly deploy and starting working on each template.

damithc commented 5 years ago

Currently I am hosting it on my own repository: https://github.com/Crphang/webrepo. Would it be good to create one to be hosted within Markbind account?

Yes, I think so.

Some design decisions on repository: I added the markbind site within your_site to have a clear separation of concern between netlify dependencies for deployment (which our user should not care about going forward) and the actual content that the user should be focused on.

@yamgent what do you think?

Going forward, I see this being very useful for enhancing Markbind templates feature:

I think that's a good idea too 👍

yamgent commented 5 years ago

Currently I am hosting it on my own repository: https://github.com/Crphang/webrepo. Would it be good to create one to be hosted within Markbind account?

Sure, if we are going to host multiple templates in the future, might be even better to create a new organization for them, unless Netlify supports putting everything in one repo?

Some design decisions on repository: I added the markbind site within your_site to have a clear separation of concern between netlify dependencies for deployment (which our user should not care about going forward) and the actual content that the user should be focused on.

Sure, I am fine with that.

yamgent commented 5 years ago

@Crphang I have duplicated your repo into https://github.com/MarkBind/init-typical-netlify, you can do any additional changes here.

crphang commented 4 years ago

@yamgent, could we have this https://github.com/Crphang/minimalrepo duplicated as well? I'll then make a PR with one-click deploy on our templates page that is based off the repo hosted in the organization as shown below:

image

yamgent commented 4 years ago

https://github.com/MarkBind/init-minimal-netlify

damithc commented 4 years ago

How do we git this to appear for MarkBind? image

yamgent commented 4 years ago

We will need to create another PR to staticgen, with the following changes, to incorporate the "Deploy to Netlify" button:

diff --git a/content/projects/markbind.md b/content/projects/markbind.md
index df1d82d..2bacde0 100644
--- a/content/projects/markbind.md
+++ b/content/projects/markbind.md
@@ -9,6 +9,7 @@ license:
 templates:
   - Custom
 description: Optimized for generating technical documentation and educational websites from Markdown text.
+startertemplaterepo: MarkBind/init-typical-netlify
 ---

 MarkBind is a website generator that can generate a website from markdown documents. While there are other markdown-to-html website generators around, MarkBind can generate more dynamic websites, as opposed to one-size-fits-all static content. MarkBind is particularly suitable to create content-heavy websites e.g., eLearning websites, online instruction manuals, project documentation etc. that aim for self-directed consumption.
damithc commented 4 years ago

We will need to create another PR to staticgen, with the following changes, to incorporate the "Deploy to Netlify" button

@Crphang can?

crphang commented 4 years ago

Create PR on their side: https://github.com/netlify/staticgen/pull/654

Demo: https://deploy-preview-654--staticgen.netlify.com/