Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Building a new website + docs #79

Open
wout opened this issue Aug 10, 2019 · 6 comments
Open

Building a new website + docs #79

wout opened this issue Aug 10, 2019 · 6 comments

Comments

@wout
Copy link
Member

wout commented Aug 10, 2019

As mentioned on Gitter, let's brainstorm about a better way to build a website and docs for SVG.js. I'll do the hard part, but I want it to be easier to maintain than what we have now.

@Fuzzyma
Copy link
Member

Fuzzyma commented Aug 10, 2019

I would jump on the train right away but every bit of free time goes into my diploma currently :D.
Saivan and me made a list what changes we nerd in the content of the docs. However we didn't talk to much about technical stuff to make it easier to maintain

@wout
Copy link
Member Author

wout commented Aug 10, 2019

@Fuzzyma I'm not going to keep you from the necessary work. I'd only like to ping about ideas for a new documentation system. I love Jekyll, as I love Ruby :), but I want everybody to feel comfortable with it this time around.

@saivan
Copy link
Member

saivan commented Aug 12, 2019

Well, I think ruby is great, but I don't use it all that much. It might be good to go with a familiar documentation system. Something like https://docsify.js.org/#/ is good. What we currently have is fine too, but having the sidebar always dock to the left would make it much more useable :P

@Fuzzyma and I made a todo list but both of us are way too short on time right now to make any useful progress on it. Although I'm sure either of us would happily answer questions about the changes we made.

@saivan
Copy link
Member

saivan commented Aug 12, 2019

Also the getting started page is in dire need of some love XD and the new animation system is super powerful :P @Fuzzyma has heaps of demos stashed somewhere

@wout
Copy link
Member Author

wout commented Aug 12, 2019

Well, I think ruby is great, but I don't use it all that much. It might be good to go with a familiar documentation system. Something like https://docsify.js.org/#/ is good. What we currently have is fine too, but having the sidebar always dock to the left would make it much more useable :P

@Fuzzyma and I made a todo list but both of us are way too short on time right now to make any useful progress on it. Although I'm sure either of us would happily answer questions about the changes we made.

I think it's useful to have something more maintainable. Docsify looks great! I'll have a look at it.

@saivan
Copy link
Member

saivan commented Aug 12, 2019

I think thats a good idea. Maintainable and markdown would be super nice XD Although we would still need an easy way to get examples in.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants