Skip to content

Mkdocs rewrite #33

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

Open
wants to merge 34 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
137111c
Setup
SnaveSutit Feb 27, 2024
d5c358f
66% done
SnaveSutit Mar 6, 2024
67590e8
First draft
SnaveSutit Mar 8, 2024
b759230
Fixes
SnaveSutit Mar 8, 2024
6997b21
Update javascript-blocks-and-contexts.md
SnaveSutit Mar 8, 2024
9f4cc03
mike
SnaveSutit Mar 8, 2024
0739bde
Delete style.css
SnaveSutit Mar 8, 2024
067298c
Create requirements.txt
SnaveSutit Mar 8, 2024
aa08f18
Update .gitignore
SnaveSutit Mar 8, 2024
a46abd3
Update README.md
SnaveSutit Mar 8, 2024
68b3236
Improvements
SnaveSutit Mar 8, 2024
c3fe394
remove unused mike
SnaveSutit Mar 10, 2024
d39498f
wip migration guide
IanSSenne Mar 10, 2024
44913a5
Second pass on migration guide
SnaveSutit Mar 10, 2024
cefb07f
update migration guide
IanSSenne Mar 24, 2024
c7fe380
update migration guide
IanSSenne Mar 24, 2024
bb2db47
update example configs.
IanSSenne Mar 24, 2024
d767c39
use correct mc-build version for alpha
IanSSenne Mar 24, 2024
0785fab
update migration guide, add link to Imports page on the templates page
IanSSenne Mar 26, 2024
a147839
Improve clarity, and avoid the first person. 🫵
SnaveSutit Mar 27, 2024
087fbbf
Improve relative import example, and wording
SnaveSutit Mar 27, 2024
bb5ff3a
Fix import examples
SnaveSutit Mar 27, 2024
4e6b3d3
⏹️ Add missing `block` template argument type.
SnaveSutit Apr 10, 2024
17b961e
Add new clock syntax to migration guide
SnaveSutit Apr 11, 2024
4cdaf46
schedule & if / unless function
SnaveSutit Apr 17, 2024
ee77440
Fix incorrect schedule command syntax
SnaveSutit Apr 20, 2024
863c139
Improve embed(Block) description, and fix typo
SnaveSutit Apr 28, 2024
419dcaf
Update to MC-Build v3.1.1
SnaveSutit May 5, 2024
4885b64
➕ Enchantment JSON files
SnaveSutit May 5, 2024
ab69477
⬆️ Update outdated wording on function definitions
SnaveSutit May 5, 2024
1ebbdfd
🚧 Object destructuring
SnaveSutit Aug 2, 2024
bb6f530
update getting-started
IanSSenne Oct 6, 2024
8817e94
add code of conduct
IanSSenne Oct 28, 2024
5c941c7
disable generating functions in a multi line block example
IanSSenne Nov 15, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 0 additions & 36 deletions .github/workflows/node.js.yml

This file was deleted.

21 changes: 1 addition & 20 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,20 +1 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
site
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"workbench.iconTheme": "material-icon-theme"
}
36 changes: 5 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,7 @@
# Docs
# Horay! Docs!

This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
# How to serve the docs
`python -m mkdocs serve`

## Installation

```console
yarn install
```

## Local Development

```console
yarn start
```

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

## Build

```console
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Deployment

```console
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
# How to push to gh-pages
`python -m mkdocs gh-deploy`
2 changes: 2 additions & 0 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- [x] Create a migration Guide
- [ ] Document [Compiler Context](https://github.com/mc-build/mcb/blob/main/src/mcl/Compiler.hx#L285-L304)
3 changes: 0 additions & 3 deletions babel.config.js

This file was deleted.

File renamed without changes.
2 changes: 1 addition & 1 deletion src/pages/code-of-conduct.mdx → docs/code-of-conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,4 +97,4 @@ typescript community code of conduct: https://github.com/typescript-community/go
contributor-covenant homepage: http://contributor-covenant.org
contributor-covenant version: http://contributor-covenant.org/version/1/4/

- see hack and tell COC for the definition (https://hackandtell.org/#code_of_conduct)
- see hack and tell COC for the definition (https://hackandtell.org/#code_of_conduct)
61 changes: 61 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Getting Started with MC-Build

Getting started with MC-Build is easy! This guide will walk you through the process of installing MC-Build and creating your first project.

## Installing MC-Build
In order to install MC-Build, You'll first need Node.js.

If you don't already have Node.js, visit their site ([nodejs.org](https://nodejs.org/en/)) and download and run the installer.

Once you've installed Node.js, open a command prompt and run the following command:

```bash
npm i -g mc-build@latest
```

That's it! MC-Build is now installed.

You can run `mcb` in the command prompt to verify that MC-Build is installed correctly:

```
$ mcb
MCB - A Minecraft Data Pack build tool.

Usage: ...
```

## Creating a New Project.

MC-Build comes with a command to help you quickly setup a new project. Simply navigate to your chosen `world/datapacks` folder, then run the following command:

```bash
mcb create my_epic_datapack
```

This will create a new folder called `my_epic_datapack` in your `world/datapacks` folder, and set up a basic project structure for you.

## The Project Structure

- `my_epic_datapack` - This is the root folder of your project.
- `pack.mcmeta` - This file is identical to a vanilla `pack.mcmeta` file.
- `src/` - This folder is where you'll write your MC-Build code.
- `data/` - MC-Build will compile your code into this folder, which is the same structure as a vanilla data pack.
- `mcb.config.js` - The configuration file for your project.

## Building Your Project

Navigate to your project folder and run the following command:

```bash
mcb watch
```

This will start the MC-Build compiler in watch mode, which will automatically compile your code whenever you make changes.

You can also run `mcb build` to compile your code once, without watch mode.

That's it! Your project is now ready for development.

## What's Next?

Check out the [Language Features](language-features/index.md) documentation for more information on how to write MC-Build code.
File renamed without changes.
File renamed without changes
10 changes: 10 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Welcome to the MC-Build Documentation!

Check out the [Getting Started](getting-started.md) guide to learn how to install and use MC-Build.

## What is MC-Build?
MC-Build is a Data Pack pre-compiler language. Designed as a superset of Minecraft's commands, it's aimed to make it easier to write and maintain complex Data Packs without needing to learn or use an entirely different language.

## Community

Join our [Discord Server](https://discord.gg/kpGqTDX)! We're always happy to help out and answer any questions you might have.
32 changes: 0 additions & 32 deletions docs/landing.md

This file was deleted.

25 changes: 0 additions & 25 deletions docs/lang-mc/Getting-Started.md

This file was deleted.

Loading