Releases: hang-up/buuk
v4.1.4
v4.1.3
v4.1.2
v4.1.1
v4.1.0
v4.0.2
v4.0.1
v4.0.0
v4.0.0
Javelin
🚀 New Features
-
CLI
- Commands. Bük is now distributed as a global package exposing a cli.
3 commands are included to initialize a project (buuk init <folder>
), preview it (buuk watch
) and build it for production (buuk build
). - Config files. Configuration is now split between 3 files:
buuk-config.js
: Customization keys (name, short name, description, ...).buukrc.json
: Hidden file used by the cli, you shouldn't have to interact with itmanifest.json
: Same since the beginning! Used for articles hierarchy.
- Commands. Bük is now distributed as a global package exposing a cli.
-
Default theme
- You will notice the default theme has changed! Under the hood,
v4
discardedmaterialize.css
in favour ofVuetify
. This also allowed to have a more streamlined look while reducing our need of dependency towards external library such as jQuery.
- You will notice the default theme has changed! Under the hood,
-
Markdown templating
- You will be able to customize the way your articles are being displayed with custom markdown template stylesheets. For now there is only one template
wiki
, served by default.
- You will be able to customize the way your articles are being displayed with custom markdown template stylesheets. For now there is only one template
-
Better searching capability
- Searching an article in
v4
will take into consideration the content of your article. Although still available to further skew results, tags are no more needed in yourmanifest.json
to have a functional search engine.
- Searching an article in
🧠 Internal changes
-
Loaders
-
The internal architecture of Bük has been reworked.
A loader is a single function that returns a promise once its operations are done. Usually, a loader should have one single responsibility and is used to set up Bük before user interactions occur. Loaders can interact with some of the application's components such as the store and the router while they must emit an event to communicate with the rest of the application. A simili pub/sub pattern is used thereon, once the user has started interacting. -
window.EventBus
All custom events emitted by loaders will be emitted on a globally availablewindow.EventBus
.
-
-
Updated markdown rendering
Where before we made use of the excellentmarkdown-it
as our markdown parser,v4
is usingmarked
as its underlying engine. The choice of speed and dependency size motivated the switch.
Upcoming features for v4.x
- Multilang
- Better error logging
- Migrate to webpack 4 stable for better loading performance
- Auto summarization of long articles