search

ortiza5 / modding-vivaldi

A not-even-WIP-anymore collection of guides about modifying the Vivaldi browser
The Unlicense
7 stars 1 forks source link

[Publishing] Github Pages #11

Open code3z opened 3 years ago

code3z commented 3 years ago

Should we have a github pages for this guide? Other than looking nice, it would also make it easily searchable and navigatable.

ghost commented 3 years ago

I was also thinking about this, but I was unsure about whether it can be done w/o doing the changes on two branches 🤷

code3z commented 3 years ago

I’m not sure what you mean.

code3z commented 3 years ago

The pages would be to publish it, not edit.

ghost commented 3 years ago

Yeah, but I’m not sure if it can be done without either polluting all the files on this branch or creating an extra branch (which would then have to be updated separately). The worse it gets if you want full-site searching and whatnot (if it can be done at all).

code3z commented 3 years ago

Ok

code3z commented 3 years ago

https://docsify.js.org/#/

I could set this up once we have 6 or so pages.

code3z commented 3 years ago

creating an extra branch (which would then have to be updated separately)

But, github branches can be updated in two clicks. And we only need to update it when files are ready for release. Or, if we only merge into master when files are ready to be published, we probably don't need to create another branch. I don't think it would get too polluted, but we'll see.

code3z commented 3 years ago

Would you want to host the webpages on js.org, github.io, or another place?

ghost commented 3 years ago

Would you want to host the webpages on js.org, github.io, or another place

If anything, I’d choose the ‘usual’ place, that is tiosgz.github.io/modding-vivaldi

code3z commented 3 years ago

Assign Me

code3z commented 3 years ago

I'm thinking not use NPM to avoid polluting master. Most of the docsify plugins don't seem to have an NPM package anyways.

Would you want to have templates (like wikipedia), like {{ work-in-progress }} or {{ outdated }}?

ghost commented 3 years ago

I don’t care about adding a single file or folder. What I don’t want is to add something into every single file.

code3z commented 3 years ago

Not sure which you are commenting on.

If you are talking about NPM: nothing would need to be added to existing files, but NPM would add multiple files and folders with little benefit.

If you are talking about templates: they only need to be added when it makes sense. For instance, External Resources would get a work-in-progress. It would look fine in plaintext, but on the website it would render into a nice little box encouraging the user to comment on the file or edit the file.