Move docs to dexie.org

[dfahlander]

Follow-up from #22.

[dfahlander]

The jekyll branch: Just followed the guide for setting up jekyll on github. index.html was renamed.

The goal should be to rewrite the current index.html to be jekyll-compliant and have links to the documentation.

[dfahlander]

To get it moving, I've now merged in the branch to the main gh-pages branch, so we can watch it at http://dexie.org/jekyll-index.html.

Also created a github project with some tasks we will need to do: https://github.com/dfahlander/Dexie.js/projects/1

[nponiros]

Nice! Will have a look at it later tonight and try to asses how much effort it will take to convert the wiki pages to jekyll compatible markdown

[dfahlander]

There's a nice guide here. I think we should put the MD files under a new directory _pages rather than _posts. https://www.taniarascia.com/make-a-static-website-with-jekyll/

[dfahlander]

I was able to test site locally after installing jekyll by writing

jekyll serve

I could then view the site through http://localhost:4000/jekyll-index.html

[nponiros]

So I had a quick look at jekyll after spending half an hour installing it and resulting in removing the Gemfile and Gemfile.lock (there is some version mismatch I guess). The good news is that converting the wiki pages shouldn't be more work than with the tool I created. I guess it will take half a day to a day to add front-matter, fix all links, add links to edit the file. The bad news is I will need to create layouts in jekyll and I'm not familiar with its syntax. I would say depending on the requirements (how many different layouts are needed, do we switch to sass, different headers/footers etc) the switch shouldn't take more than a few days.

Personally I think we should start with the simplest possible solution (probably just take the layout from the demo site I created) and after we made the switch we can improve the layouts etc. The reason for that: the longer we keep docs in the website git and the wiki the more work it will be later to again migrate any changes made in the wiki.

[dfahlander]

A minimal design is a big step anyway. Could improve design later on.

[nponiros]

Well I'm making some progress here. I created a docs folder instead of _pages because it is easier this way to have the right URLs later. Next step would be to add front-matter, fix the layout and remove useless stuff

[nponiros]

@dfahlander do you like the design of the demo site (documentation part, index was unchanged) I made for a first version or do you want anything changed?

[dfahlander]

I think it's fine for now. It seems to use the same font and the same logo which is good. Could be enhanced over time. The blue background color seems a little to strong maybe. A lighter color might be better. Table of contents might be possible to improve. Maybe have list-style: none on the items in table of contents. Possibly have a fixed height and overflow-y: auto on it to generate scrollbars. But I could laborate with the design when I get some time. Also see if we could sew it together better with the index page.

[nponiros]

okay. I will see what I can do. I will create a PR for the website repo (Saturday at latest) so you can have a look and make changes.

[nponiros]

Pull request is open dexie/dexie-website#3 .

[nponiros]

@dfahlander please enable issues for the dexie.js-web repository. I found some links which are broken in the wiki (Promise.then(), Promise.catch()) do not exist as wiki pages. It would be could if we can have issues like that on the dexie.js-web repo.

[dfahlander]

It's enabled

[dfahlander]

Thanks @nponiros for the awesome work with moving the docs! It's now up and running on http://dexie.org/docs. Anyone following this issue, please have a look at the new docs and give your feedback!

[dfahlander]

Closing this as docs are moved.