https://github.com/jbltx/discordfx

DocFX template to create documentation similar to Discord
https://github.com/jbltx/discordfx

discord docfx documentation style template theme

Last synced: 6 months ago
JSON representation

DocFX template to create documentation similar to Discord

• Host: GitHub
• URL: https://github.com/jbltx/discordfx
• Owner: jbltx
• License: mit
• Created: 2020-09-04T14:46:30.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-23T18:59:38.000Z (over 2 years ago)
• Last Synced: 2023-08-05T11:13:13.892Z (over 2 years ago)
• Topics: discord, docfx, documentation, style, template, theme
• Language: CSS
• Homepage: http://jbltx.com/DiscordFX
• Size: 1.76 MB
• Stars: 38
• Watchers: 3
• Forks: 8
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# DiscordFX

[DocFX](https://dotnet.github.io/docfx/index.html) template to create documentation similar to [Discord](https://discord.com/developers/docs/intro)

### [Live Demo](https://jbltx.com/DiscordFX)

![DiscordFX - Desktop Screenshot](./demo/images/discordfx-screenshot01.png)

![DiscordFX - Mobile Screenshots](./demo/images/discordfx-mobile-screenshots.png) 

## Installation 

1. Download the source or the zipped file from the [releases page](https://github.com/jbltx/DiscordFX/releases).

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

   ```json

   {

       "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.