Creating Wiki Descriptions

There are three main ways to create wiki descriptions, depending on how much time you wanna invest and how good you want them to be.

Manual Wiki.

The wiki descriptions follow this syntax

ItemName = {
  { -- Category 1
    {str = "Category 1", fsize = 2, clr = 3, halign = 0},
    (str = "Paragraph 1"},
    (str = "Paragraph 2"},
  },
  { -- Category 2
    {str = "Category 2", fsize = 2, clr = 3, halign = 0},
    (str = "Paragraph 1"},
    (str = "Paragraph 2"},
  },
}

• ItemName: The table key, you are the only one accessing this table.
• Categories: Each category in the wiki is its own sub-table.
• Headers: The headers are not mandatory, but can make the category look better.
  • For consistency sake, it is recommended to follow the same syntax ({str = "name", fsize = 2, clr = 3, halign = 0}) for all headers.
• Paragraphs: They contain all of the information for your item.
• Note: When working with multiple items, it's recommended to use a main Wiki table to contain all wikis. The main purpose of this note is to not get confused when reading my next examples.

Example:

Encyclopedia.ItemsWiki = {
  -- Other items.
  COLLECTIBLE_MAXS_HEAD = {
    { -- Effects
      {str = "Effects", fsize = 2, clr = 3, halign = 0},
      {str = "+0.5 damage up."},
      {str = "x1.5 damage multiplier."},
    },
    { -- Notes
      {str = "Notes", fsize = 2, clr = 3, halign = 0},
      {str = "The x1.5 damage multiplier does not stack with the x1.5 damage multiplier from  Magic Mushroom, from the combination of  The Book of Belial and  Blood of the Martyr, or itself (by using an item such as  Diplopia, for example). However, it will stack with any other multipliers, such as  Sacred Heart."},
    },
    { -- Trivia
      {str = "Trivia", fsize = 2, clr = 3, halign = 0},
      {str = "In the original Binding of Isaac, this item was known as ''Max's Head''. Max was the name of a dog that Edmund McMillen wanted as a child, but never got."},
      {str = "The filename for the item icon in the game files still refers to it as ''Max's Head''."},
      {str = "Cricket's Head is named after one of Ed's former cats who is now rehomed, Cricket."},
      {str = "The shocked look on Isaac's face implies that like with many children, his pet's death was kept secret from him."},
      {str = "Although  Cricket's Body and Cricket's Head are presumed to be from the same animal, Cricket's Body has darker fur color and spots than Cricket's Head."},
    },
  },
  COLLECTIBLE_MY_REFLECTION = {
    { -- Effects
      {str = "Effects", fsize = 2, clr = 3, halign = 0},
      {str = "Isaac's tears travel a short distance, then reverse direction and return to Isaac."},
      {str = "The tears are constantly pulled towards Isaac; if Isaac moves after shooting, the tears will always return to him."},
      {str = "+1.5 range"},
      {str = "x1.6 shot speed"},
      {str = "+1 shot height"},
    },
    { -- Trivia
      {str = "Trivia", fsize = 2, clr = 3, halign = 0},
      {str = "Isaac's appearance may be a reference to the anime Sailor Moon. The main character (Sailor Moon) has a crescent on her forehead and a secondary character (Sailor Neptune) uses a mirror as a source for her powers."},
      {str = "The item's sprite and effect may be a reference to the urban myth that if someone breaks a mirror, they will have bad luck for 7 years - Isaac's bad luck comes in the form of having his tears return to him."},
      {str = "This item is used in Challenges #7 (Suicide King) and #15 (Slow Roll)."},
    },
  },
}

Autogenerating from External Item Descriptions' descriptions.

Encyclopedia.EIDtoWiki(desc, title)

• desc: 'string'. The EID description.
• title: string. The custom header/title you want your wiki to have. (optional, defaults to "Effect".)

Example.

local FunkyDescription = "{{ArrowUp}} Gives you a lot of funk. #If you get enough funk, you will summon Funky Kong."
local ChunkyDescription = "And then there's Chunky! #... #{{WARNING}} He's dead."

local FunkyWiki = Encyclopedia.EIDtoWiki(FunkyDescription)
local ChunkyDescription = Encyclopedia.EIDtoWiki(FunkyDescription, "Rest in peace")

Output:

{
  {
    {str = "Effect", fsize = 2, clr = 3, halign = 0},
    {str = "Gives you a lot of funk."}
    {str = "If you get enough funk, you will summon Funky Kong."}
  }
}
{
  {
    {str = "Rest in peace", fsize = 2, clr = 3, halign = 0},
    {str = "And then there's Chunky!"}
    {str = "... "}
    {str = "He's dead."}
  }
}

Autogenerating from your mod's wiki using Python.

Bundled with the mod, there is a folder called wiki_scraps, it's the tool I made and used to get all of the wiki descriptions for items and trinkets. Feel free to modify it and use it to scrap your own mod's wiki entries, the readme.txt should have enough info to let you know what you should modify to make it work on your wiki.