Giter Club home page Giter Club logo

unityfx's Introduction

UnityFX

DocFX Template to create Unity-esque code documentation. Demo

Based of the DocFX Material https://ovasquez.github.io/docfx-material/

Changes from Default Template

  • Full Width
  • Custom TIP alert
  • Different colors
  • Custom Breadcrumb
  • Custom Sidebar

How to use

  1. install docfx

  2. The template is contained in the templates folder. Drop the entire folder into your root-level docfx project folder, next to your api/ and articles/ folders.

  3. In your docfx.json (showing only relevant portion):

{
    "build": {
        "template": [ "default", "templates/unity" ],
    }
}
  1. compile as you would using the default template

Contribute

You are more than welcome to contribute. No code of conduct required, just be reasonable.

Open TODOs:

  • Search in navbar
  • table for public properties and fields

Disclaimer

Notice of Non-Affiliation and Disclaimer

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

unityfx's People

Contributors

code-beans avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

unityfx's Issues

List of namespaces is broken - cuts off after 19 items

If you have a really small project, or not much code, you won't notice this.

For all other cases: it's unusable. This template generates a scrollbar on the left-hand panel of http://localhost:8080/api/index.html that cuts off the bottom 2-3 items and makes them inaccessible. The items are in the HTML page source, but this CSS is blocking their display.

I'm not sure what causes it, but looks like there's excessive use of changing overflow and inserting fixed heights, presumably some of those are causing this. Converting it to plain HTML works as expeted.

Non-issue: template credits

I noticed that you based your template on my implementation of DocFX Material, I'm flattered that someone liked what I made, it would be nice if you could add a reference to my repo, something like "Based of DocFX Material https://ovasquez.github.io/docfx-material/" or something like that, to keep the spirit of community alive :)

Cheers!
Oscar

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.