Seneral / Node_Editor_Framework

A flexible and modular Node Editor Framework for creating node based displays and editors in Unity
https://nodeeditor.seneral.dev
MIT License
2.01k stars 414 forks source link

First step before replacing documentation by a markdown version. #59

Closed groud closed 8 years ago

groud commented 8 years ago

These are the first sources for the documentation. Writen with Markdown and compiled with Mkdocs.

A preview : node editor 2016-03-15 23-08-43

Seneral commented 8 years ago

Hey @groud, will you update this with the other pages? It looks amazing btw:)

groud commented 8 years ago

Well, I can do that. But is it really useful if we plan to put the whole documentation into the wiki repository ? I am still waiting for a decision from @Baste-RainGames about giving us right on this wiki repository (I have no idea about how to do that, btw :/ )

Seneral commented 8 years ago

We can do both since we can use MK for both, right? Additionally a standalone online documentation makes a good impression I think;) Also I could create the wiki pages, but only @Baste-RainGames can elect contributors, so if you could respond that'd be great;) I'm currently trying to install mkDocs

groud commented 8 years ago

If we can the put all MD files into the wiki repository with the compilation files (the mkdocs.yml file), I though we would keep only the compiled (i.e. html) files into the gh-pages branch and into the docs folder.

Seneral commented 8 years ago

Yup, sounds about right. On a side note, I seem unable to install mkDocs :( When the installation notes refer to a command (MKDocs, pip, ...) which console do I use? The normal cmd reports 'python' does not exist even when having it installed and the python console doesn't accept these commands either. I'm not that into python to get this :D EDIT: Ok I got why it didn't register python, I unselected to add it to the path on installation:)

groud commented 8 years ago

Normally it should work if you use cmd, but you can use powershell instead. If it does not work with 'python', try 'python.exe' instead.

Check your python version, the 3.5 one comes with pip, while the 2.* don't.

Pip commands should also be executed into cmd/powershell shells, not into the python's one.

Seneral commented 8 years ago

Yeah it does work now, just missed to add python to the path variable when installing. Only realized this as I tried the older 2.7.11 which actually explained what that does, I simply unchecked it in the first install because I though I didn't need it :'D It is looking really pretty. Though the theme your using is deprecated, it says... If you don't mind I'll experiment with it a bit:)

groud commented 8 years ago

Well, do not hesitate to checkout my branch, create a new branch from there, push your changes into your own fork, then create a pull request into my branch. ^^

Seneral commented 8 years ago

Yep good idea:) The changes are not yet committed so we should leave this open until we're happy with the page so far (of course it's a ongoing WIP) For me that means only the style to go;) Do you have any ideas/improvements?

Seneral commented 8 years ago

Maybe we can structure it a bit better, including subpages, etc. Not today though, atleast for me:)

Seneral commented 8 years ago

Also, any idea how we can remove the duplicate page link 'Node Editor Framework' and 'Home' to the index page?

groud commented 8 years ago

I merged the pull request. The check failed comes from travisCl, I was testing this module that can perform building tests when a pull request is made. :)

Actually I did not check the content yet, I do not know the Framework enough to have pertinent comments on the documentation ^^

groud commented 8 years ago

Double link removed. :)

Seneral commented 8 years ago

Oh misunderstood your previous post

Also, that was the reason I asked, removing this won't compile;)

groud commented 8 years ago

@Seneral , lol, this worked fine with another project. I'll fix this

Seneral commented 8 years ago

Sorry it will compile but the index.md page is completely left out.

groud commented 8 years ago

Well, I more or less fixed this... ^^

Seneral commented 8 years ago

Really good idea! That'll do:)

Seneral commented 8 years ago

Wait: this also hides the search field :O It is also the first element in a list:(

Seneral commented 8 years ago

Can you exclude classes from css? Then excluding 'navbar-right' should do it

Seneral commented 8 years ago

This css works:

ul.nav.navbar-nav:not(.navbar-right) li:first-child {
    display: none;
}
groud commented 8 years ago

Done.

Seneral commented 8 years ago

Cool