Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor file download system to unpack from index.php #166

Closed
sbrl opened this issue Feb 26, 2019 · 2 comments
Closed

Refactor file download system to unpack from index.php #166

sbrl opened this issue Feb 26, 2019 · 2 comments
Labels
Area: Code It's got something to do with code bug Squash it quick! enhancement Let's make it better!

Comments

@sbrl
Copy link
Owner

sbrl commented Feb 26, 2019

Looks like this rework it more urgent than I thought. RawGit, the mechanism we use to download Parsedown, is shutting down in October this year. To this end, I'd like to move away from the current system of downloading files from RawGit to a system on unpacking from index.php and make a stable release before October 2019.

We should open a separate issue for this.

Originally posted by @sbrl in #164 (comment)

@sbrl sbrl changed the title Looks like this rework it more urgent than I thought. [RawGit](https://cdn.rawgit.com/), the mechanism we use to download Parsedown, is shutting down in October this year. To this end, I'd like to move away from the current system of downloading files from RawGit to a system on unpacking from index.php _and_ make a stable release before October 2019. Refactor file download system to unpack from index.php Feb 26, 2019
@sbrl
Copy link
Owner Author

sbrl commented Feb 26, 2019

We've implemented a cache system (and fixed a nasty bug in #165). Now that v0.18 is out, I think it's time to think about refactoring the downloading system to enable us to work on the server-side syntax highlighting.

It's probably worth noting that although this will allow us to bundle all sorts of extra files with Pepperminty Wiki, the intention here is to avoid using it except when we really need to. In other words, this won't be for packing multi-file modules etc - only for essential libraries that are needed to perform a function. Good examples of things include:

  • Parsedown / ParsedownExtra / ParsedownExtreme
  • Luminous
  • JSDiff

The intention here is to keep Pepperminty Wiki targeted at what it's good at: setting up a new small wiki really quickly - and avoid what we can't possibly hope to compete with (i.e. the full power of MediaWiki). Pepperminty Wiki is small, fast, and light. It's not without any bells and whistles though - we just need to be selective in the ones that we include :P

Originally posted on #164

@sbrl sbrl added bug Squash it quick! enhancement Let's make it better! Area: Code It's got something to do with code labels Feb 26, 2019
@sbrl
Copy link
Owner Author

sbrl commented Apr 6, 2019

Refactor complete! We now have a packing system in place.

We should probably figure out some way of documenting how it works better, but a note in the changelog that points to some examples is enough for now I guess :P

Come to think of it, we could do with documenting register_module() much better than we currently have, but that's a separate issue.

@sbrl sbrl closed this as completed Apr 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Code It's got something to do with code bug Squash it quick! enhancement Let's make it better!
Projects
None yet
Development

No branches or pull requests

1 participant