Giter Club home page Giter Club logo

discordfx's Introduction

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
  • Support of TOC searching/filtering

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.

discordfx's People

Contributors

jbltx avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.