Skip to content

Commit

Permalink
Merge branch 'docusaurus-frontmatter' of https://github.com/Mysteriou…
Browse files Browse the repository at this point in the history
…s-Dev/Documentation into docusaurus-frontmatter
  • Loading branch information
Mysterious-Dev committed Nov 2, 2023
2 parents 041ef68 + 726ffb1 commit 9ceb882
Show file tree
Hide file tree
Showing 26 changed files with 439 additions and 218 deletions.
1 change: 1 addition & 0 deletions .node-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
18.18.0
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The documentation is built using [Docusaurus 2](https://docusaurus.io)

## Contributing

*Contribution guidelines are currently pending.*
You can read the [contribution guidelines on the docs](https://docs.neoforged.net/contributing/).

If you wish to contribute to the documentation, fork and clone this repository.

Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/internationalization.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Read [components] for more details.

- `createComponentTranslation(CommandSource, String, Object...)` is useful for sending messages between clients and the server. If the receiver is a vanilla client, the method will eagerly localize and format the provided translation key in sender's locale, or American English if no locale is loaded; the modded server may allow vanilla clients to join, and they will lack localization data required to localize the message itself. Otherwise, the method will create the component with `TranslatableContents`.

[langs]: https://minecraft.fandom.com/wiki/Language#Languages
[langs]: https://minecraft.wiki/w/Language#Languages
[converter]: https://tterrag.com/lang2json/
[formatting]: ../misc/components.md#text-formatting
[components]: ../misc/components.md
2 changes: 1 addition & 1 deletion docs/datagen/client/localization.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,5 @@ this.addItem("example.diacritic", "Example with a díacritic");
:::

[lang]: ../../concepts/internationalization.md
[locale]: https://minecraft.fandom.com/wiki/Language#Languages
[locale]: https://minecraft.wiki/w/Language#Languages
[datagen]: ../index.md#data-providers
2 changes: 1 addition & 1 deletion docs/datagen/client/modelproviders.md
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@ public CompletableFuture<?> run(CachedOutput cache) {
[color]: ../../resources/client/models/tinting.md#blockcoloritemcolor
[overrides]: ../../resources/client/models/itemproperties.md
[blockstateprovider]: #block-state-provider
[blockstate]: https://minecraft.fandom.com/wiki/Tutorials/Models#Block_states
[blockstate]: https://minecraft.wiki/w/Tutorials/Models#Block_states
[blockmodels]: #blockmodelprovider
[itemmodels]: #itemmodelprovider
[properties]: ../../blocks/states.md#implementing-block-states
Expand Down
4 changes: 2 additions & 2 deletions docs/datagen/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@ The `GatherDataEvent` is fired on the mod event bus when the data generator is b
* [`advancements.AdvancementProvider`][advgen] - for [advancements]; pass in `AdvancementSubProvider`s to the constructor

[langgen]: ./client/localization.md
[lang]: https://minecraft.fandom.com/wiki/Language
[lang]: https://minecraft.wiki/w/Language
[soundgen]: ./client/sounds.md
[sounds]: https://minecraft.fandom.com/wiki/Sounds.json
[sounds]: https://minecraft.wiki/w/Sounds.json
[modelgen]: ./client/modelproviders.md
[models]: ../resources/client/models/index.md
[itemmodelgen]: ./client/modelproviders.md#itemmodelprovider
Expand Down
8 changes: 4 additions & 4 deletions docs/misc/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ A `Component` is a holder for text which can be formatted and chained with other
| `score` | it creates a component for representing the `objective`'s score of an entity specified by the [entity selector][selectors] `name`. |
| `selector` | it creates a component for displaying the list of names of entities selected by the [entity selector][selectors] `pattern`. |

A component's text contents are represented by `ComponentContents`. Notably, the subtype `TranslatableContents` not only supports [localization][internalization] but also [text formatting][formatting].
A component's text contents are represented by `ComponentContents`. Notably, the subtype `TranslatableContents` not only supports [localization][internationalization] but also [text formatting][formatting].

## Applying Style

Expand Down Expand Up @@ -100,10 +100,10 @@ Text formatting is the process of inserting data as text into predefined larger

Any `Component` element within `args` will be transformed into a formatted text string.

[internalization]: ../concepts/internationalization.md
[selectors]: https://minecraft.fandom.com/wiki/Target_selectors
[internationalization]: ../concepts/internationalization.md
[selectors]: https://minecraft.wiki/w/Target_selectors
[red_hello]: /img/component_red_hello.png
[style_annotated]: /img/component_style_annotated.png
[formatting]: #text-formatting
[tree]: /img/component_graph.png
[keymapping]: ./keymappings.md
[keymapping]: ./keymappings.md
2 changes: 1 addition & 1 deletion docs/misc/keymappings.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ If you do not own the screen which you are trying to check a **mouse** for, you
:::

[modbus]: ../concepts/events.md#mod-event-bus
[controls]: https://minecraft.fandom.com/wiki/Options#Controls
[controls]: https://minecraft.wiki/w/Options#Controls
[tk]: ../concepts/internationalization.md#translatablecontents
[keyinput]: https://www.glfw.org/docs/3.3/input_guide.html#input_key
[forgebus]: ../concepts/events.md#creating-an-event-handler
2 changes: 1 addition & 1 deletion docs/rendering/modelextensions/transforms.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,5 +72,5 @@ If the respective rotation is not specified, it will default to no rotation.

The scale must be specified as an array of 3 floating point values representing a three-dimensional vector: `[ x, y, z ]` and defaults to (1, 1, 1) if not present.

[blockstate]: https://minecraft.fandom.com/wiki/Tutorials/Models#Block_states
[blockstate]: https://minecraft.wiki/w/Tutorials/Models#Block_states
[displaytransform]: ../modelloaders/transform.md
4 changes: 2 additions & 2 deletions docs/resources/client/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ You can then follow the steps found [at the Minecraft Wiki][createrespack] to cr

Additional reading: [Resource Locations][resourcelocation]

[respack]: https://minecraft.fandom.com/wiki/Resource_Pack
[createrespack]: https://minecraft.fandom.com/wiki/Tutorials/Creating_a_resource_pack
[respack]: https://minecraft.wiki/w/Resource_Pack
[createrespack]: https://minecraft.wiki/w/Tutorials/Creating_a_resource_pack
[resourcelocation]: ../../concepts/resources.md#ResourceLocation
8 changes: 4 additions & 4 deletions docs/resources/client/models/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ JSON models only support cuboid elements; there is no way to express a triangula

Textures, like models, are contained within resource packs and are referred to with `ResourceLocation`s. In Minecraft, the [UV coordinates][uv] (0,0) are taken to mean the **top-left** corner. UVs are *always* from 0 to 16. If a texture is larger or smaller, the coordinates are scaled to fit. A texture should also be square, and the side length of a texture should be a power of two, as doing otherwise breaks mipmapping (e.g. 1x1, 2x2, 8x8, 16x16, and 128x128 are good. 5x5 and 30x30 are not recommended because they are not powers of 2. 5x10 and 4x8 are completely broken as they are not square.). Textures should only ever be not a square if it is [animated][animated].

[models]: https://minecraft.fandom.com/wiki/Tutorials/Models#File_path
[models]: https://minecraft.wiki/w/Tutorials/Models#File_path
[resloc]: ../../../concepts/resources.md#resourcelocation
[statemodel]: https://minecraft.fandom.com/wiki/Tutorials/Models#Block_states
[itemmodels]: https://minecraft.fandom.com/wiki/Tutorials/Models#Item_models
[statemodel]: https://minecraft.wiki/w/Tutorials/Models#Block_states
[itemmodels]: https://minecraft.wiki/w/Tutorials/Models#Item_models
[state]: ../../../blocks/states.md
[uv]: https://en.wikipedia.org/wiki/UV_mapping
[animated]: https://minecraft.fandom.com/wiki/Resource_Pack?so=search#Animation
[animated]: https://minecraft.wiki/w/Resource_Pack?so=search#Animation
2 changes: 1 addition & 1 deletion docs/resources/client/models/itemproperties.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,4 @@ private void setup(final FMLClientSetupEvent event)
}
```

[format]: https://minecraft.fandom.com/wiki/Tutorials/Models#Item_models
[format]: https://minecraft.wiki/w/Tutorials/Models#Item_models
2 changes: 1 addition & 1 deletion docs/resources/client/models/tinting.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ public void registerItemColors(RegisterColorHandlersEvent.Item event){
}
```

[wiki]: https://minecraft.fandom.com/wiki/Tutorials/Models#Block_models
[wiki]: https://minecraft.wiki/w/Tutorials/Models#Block_models
8 changes: 4 additions & 4 deletions docs/resources/server/advancements.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,8 +160,8 @@ When an advancement is completed, rewards may be given out. These can be a combi
}
```

[datapack]: https://minecraft.fandom.com/wiki/Data_pack
[wiki]: https://minecraft.fandom.com/wiki/Advancement/JSON_format
[datapack]: https://minecraft.wiki/w/Data_pack
[wiki]: https://minecraft.wiki/w/Advancement/JSON_format
[conditional]: ./conditional.md#implementations
[function]: https://minecraft.fandom.com/wiki/Function_(Java_Edition)
[triggers]: https://minecraft.fandom.com/wiki/Advancement/JSON_format#List_of_triggers
[function]: https://minecraft.wiki/w/Function_(Java_Edition)
[triggers]: https://minecraft.wiki/w/Advancement/JSON_format#List_of_triggers
4 changes: 2 additions & 2 deletions docs/resources/server/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ You can then follow the steps found [here][createdatapack] to create any datapac

Additional reading: [Resource Locations][resourcelocation]

[datapack]: https://minecraft.fandom.com/wiki/Data_pack
[createdatapack]: https://minecraft.fandom.com/wiki/Tutorials/Creating_a_data_pack
[datapack]: https://minecraft.wiki/w/Data_pack
[createdatapack]: https://minecraft.wiki/w/Tutorials/Creating_a_data_pack
[resourcelocation]: ../../concepts/resources.md#ResourceLocation
4 changes: 2 additions & 2 deletions docs/resources/server/loottables.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Forge adds an additional `LootItemCondition` which checks whether the given `Loo
}
```

[datapack]: https://minecraft.fandom.com/wiki/Data_pack
[wiki]: https://minecraft.fandom.com/wiki/Loot_table
[datapack]: https://minecraft.wiki/w/Data_pack
[wiki]: https://minecraft.wiki/w/Loot_table
[event]: ../../concepts/events.md#creating-an-event-handler
[glm]: ./glm.md
2 changes: 1 addition & 1 deletion docs/resources/server/recipes/custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,6 @@ public Optional<ExampleRecipe> getRecipeFor(Level level, BlockPos pos) {
All custom recipes, regardless of input or output data, can be created into a `FinishedRecipe` for [data generation][datagen] using the `RecipeProvider`.

[forge]: ../../../concepts/registries.md#methods-for-registering
[json]: https://minecraft.fandom.com/wiki/Recipe#JSON_format
[json]: https://minecraft.wiki/w/Recipe#JSON_format
[manager]: ./index.md#recipe-manager
[datagen]: ../../../datagen/server/recipes.md#custom-recipe-serializers
4 changes: 2 additions & 2 deletions docs/resources/server/recipes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,8 @@ Larger crafting grids in recipes can be [data generated][datagen].

A few additional [ingredient types][ingredients] are added to allow recipes to have inputs which check tag data or combine multiple ingredients into a single input checker.

[datapack]: https://minecraft.fandom.com/wiki/Data_pack
[wiki]: https://minecraft.fandom.com/wiki/Recipe
[datapack]: https://minecraft.wiki/w/Data_pack
[wiki]: https://minecraft.wiki/w/Recipe
[advancement]: ../advancements.md
[datagen]: ../../../datagen/server/recipes.md
[cap]: ../../../datastorage/capabilities.md
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/server/recipes/ingredients.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ public IIngredientSerializer<? extends Ingredient> getSerializer() {
If using `FMLCommonSetupEvent` to register an ingredient serializer, it must be enqueued to the synchronous work queue via `FMLCommonSetupEvent#enqueueWork` as `CraftingHelper#register` is not thread-safe.
:::

[recipes]: https://minecraft.fandom.com/wiki/Recipe#List_of_recipe_types
[recipes]: https://minecraft.wiki/w/Recipe#List_of_recipe_types
[nbt]: #strictnbtingredient
[serializer]: #iingredientserializer
[compound]: #compoundingredient
Expand Down
8 changes: 4 additions & 4 deletions docs/resources/server/tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,8 @@ There are several conventions that will help facilitate compatibility in the eco
Tags are directly supported by Vanilla. See the respective Vanilla wiki pages for [recipes] and [advancements] for usage details.

[datapack]: ./index.md
[tags]: https://minecraft.fandom.com/wiki/Tag#JSON_format
[taglist]: https://minecraft.fandom.com/wiki/Tag#List_of_tags
[tags]: https://minecraft.wiki/w/Tag#JSON_format
[taglist]: https://minecraft.wiki/w/Tag#List_of_tags
[forgetags]: https://github.com/MinecraftForge/MinecraftForge/tree/1.19.x/src/generated/resources/data/forge/tags
[recipes]: https://minecraft.fandom.com/wiki/Recipe#JSON_format
[advancements]: https://minecraft.fandom.com/wiki/Advancement
[recipes]: https://minecraft.wiki/w/Recipe#JSON_format
[advancements]: https://minecraft.wiki/w/Advancement
9 changes: 9 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,11 @@ const config = {
position: "right",
docsPluginId: "neogradle",
},
{
to: "/contributing",
label: "Contributing",
position: "right",
},
{
href: "https://github.com/neoforged/documentation",
label: "GitHub",
Expand All @@ -139,6 +144,10 @@ const config = {
to: "/neogradle/docs/",
label: "NeoGradle Documentation",
},
{
to: "/contributing",
label: "Contributing to the Documentation"
}
],
},
{
Expand Down
43 changes: 0 additions & 43 deletions src/pages/contributing.md

This file was deleted.

Loading

1 comment on commit 9ceb882

@neoforged-pages-deployments
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploying with Cloudflare Pages

Name Result
Last commit: 9ceb882a16307197287a2c6e10f6ae0b9c676db5
Status: ✅ Deploy successful!
Preview URL: https://a87412fa.neoforged-docs-previews.pages.dev
PR Preview URL: https://pr-9.neoforged-docs-previews.pages.dev

Please sign in to comment.