Git Product home page Git Product logo

betterjdocs's Introduction

Header - BetterJDocs

This theme was specifically made to replace the old JavaDocs' Interface with a much needed improved version of its design & layout while being limited only to CSS.

If you want to check out a live demonstration, you may check Hangar4J's JavaDocs.

How to install

  1. Download the stylesheet from GitHub. (betterjdocs.css)
  2. Place the file inside your project in a place of your choice.
  3. Check below to see how to add the style to your project.

Using Gradle:

javadoc {
  // Your own configurations...
  options.stylesheetFile = file('path/to/betterjdocs.css')
}

Using other methods:

  • I only use Gradle, if you know how to do it in any other way, please consider contributing.

How to customize

If you dislike the default colors, or just want to modify it to fit your own projects, you can modify the colors by opening the stylesheet.

Variable Description
--primary-color Mostly used on links & buttons.
--secondary-color Used in fields, parameters, types, etc.
--description-color Used specifically for descriptions and text.
--hover-color Hover color for links.
--bg-900-color Color for Top Navigation and Cards.
--bg-800-color Color used in the body's background.
--bg-700-color Mostly used for the odd row in tables.
--bg-600-color Mostly used for the even row in tables and used for the searchbar.

There are also comments explaining what each variable corresponds to and what it does inside the stylesheet.

Contact me

If you have any questions or feedback, please contact me via Discord: @mrafonso.

betterjdocs's People

Contributors

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