Jump to content

Documentation Sneak Peak


Josh

1,736 views

 Share

I am happy to show you a preview of the new documentation system I am working on:

docs.thumb.png.767bca612895556dd77d532fa0e78170.png

Let's take a look at what is going on here:

  • It's dark, so you can stare lovingly at it for hours without going blind.
  • You can switch between languages with the links in the header.
  • Lots of internal cross-linking for easy access to relevant information.
  • Extensive, all-inclusive documentation, including Enums, file formats, constructors, and public members.
  • Data is fetched from a Github repository and allows user contributions.

I am actually having a lot of fun creating this. It is very fulfilling to be able to go in and build something with total attention to detail.

  • Like 5
 Share

2 Comments


Recommended Comments

I have some really beautiful code highlighting added:
 

#include "pch.h"
#include "Project.h"

int main(int argc, const char* argv[])
{
    //Get the displays
    auto displays = ListDisplays();

    //Create a window
    auto window = CreateWindow(displays[0], L"", 0, 0, 1280, 720, WINDOW_CENTER | WINDOW_TITLEBAR);

    //Create a framebuffer
    auto framebuffer = CreateFramebuffer(window);

    //Create a world
    auto world = CreateWorld();

    //Create a camera
    auto camera = CreateCamera(world);
    camera->SetClearColor(0.125);
    camera->Move(0, 1, -3);
    camera->SetFOV(70);

    //Create light
    auto light = CreateLight(world, LIGHT_DIRECTIONAL);
    light->SetRotation(45, 35, 0);

    //Create ground
    auto ground = CreateBox(world, 10, 1, 10);
    ground->SetPosition(0, -0.5, 0);
  • Like 2
Link to comment
Guest
Add a comment...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

×
×
  • Create New...