Lore 101

Muze Lore is powered by Docusaurus. If you wish to start you own Document website visit this link: docusaurus.new.

To Write the Lore

As it is a web framwork you will need to clone the repo into your system. Clone from bitbucket.

What you'll need

• Node.js version 18.14 or above:
  • When installing Node.js, you are recommended to check all checkboxes related to dependencies.

Run local copy

Run the development server:

git clone git@bitbucket.org:muze/mz-ic-lore.git
cd mz-ic-lore
nvm use # optional
npm install
npm run start

Write your Lore

The npm run start command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.

Open docs/intro.md (this page) and edit some lines: the site reloads automatically and displays your changes.

Installed Plugins

Our Muze Lore already equipped with few plugins.

Diagrams

We already have the mermaid installed. Hence your markdown will be able to render these diagrams.

For complete list of supported diagrams please checkout mermaid

To Publish the Lore

the repo already uses bitbucket pipeline to automatically deploy changes using branches.

auto-deploy branch	published URL
develop	https://lore-staging.muze.co.th/
release/production	https://lore.muze.co.th/