Skip to content
forked from jbltx/DiscordFX

DocFX template to create documentation similar to Discord

License

Notifications You must be signed in to change notification settings

openmod/DiscordFX

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

62 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DiscordFX

DocFX template to create documentation similar to Discord

DiscordFX - Desktop Screenshot

DiscordFX - Mobile Screenshots

Installation

  1. Download the source or the zipped file from the releases page.
  2. In your DocFX project folder, create a new directory named templates, if it doesn't already exist.
  3. Copy the discordfx folder from this repository into your templates folder.
  4. In your docfx.json configuration file, add templates/discordfx path into build.template property
    {
        "build": {
            "template": ["default", "templates/discordfx"]
        }
    }

Customization

Colors

You can change any color which are used by the template.

They are defined in the styles/colors.css file.

To change it, just override the value in your own styles/main.css file for example.

Todos

  • Add documentation versioning

Disclaimer

Notice of Non-Affiliation and Disclaimer

We are not affiliated, associated, authorized, endorsed by, or in any way officially connected with Discord, or any of its subsidiaries, partners or its affiliates. The official Discord website can be found at https://discord.com/. "Discord", Discord logos, and other Discord trademarks are trademarks or registered trademarks of Discord or its affiliates in the U.S. and elsewhere.

About

DocFX template to create documentation similar to Discord

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 55.2%
  • JavaScript 44.8%