Website design

[nzakas]

We need a website to post Espree documentation and a demo. It would be nice if it had the same visual language as the eslint.org, but I don't think that's 100% necessary.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

[markphd]

I'd like to help. Other than visual appearance, may I know what other requirements I should keep in mind? Nevertheless, I'll start with a design mockup based on ESLint site.

[nzakas]

@markphd thanks.

[nzakas]

Oops, hit enter too soon. The site is primarily for documentation, so typography and ease of reading is the primary concern. We will host on GitHub using GitHub pages, so we are limited in how dynamic the content will be.

At a high level I see the following sections:

1. About - basic information about the project
2. Usage - how to use the API
3. Developer guide - for contributors (likely similar to http://eslint.org/docs/developer-guide/)
4. Demo - a demo page similar to http://esprima.org/demo/parse.html
5. AST Reference - documentation on the varies AST nodes. Similar to https://developer.mozilla.org/en-US/docs/Mozilla/Projects/SpiderMonkey/Parser_API#Node_objects. Bit probably one page per node type. I put together some samples content here: https://github.com/eslint/espree/blob/master/docs/ast/literal.md

Let me know if you have other questions.

[markphd]

Acknowledged. I am working on few sketches to produce the design mockup.

So part of my idea is to make the home page contain the available content in Espree's github and add a separate Docs link as dedicated Documentation similar to ESLint Docs.

For the typeface, I chose Avenir because of the number of font style available and it is easy to read even in smaller text. But ofcourse if you prefer something else, please let me know. Here is how it looks: little teaser.

Note: I just made up the logo so we can replace it as soon as the official one is available.

[FredKSchott]

WOAH! @markphd that mockup looks awesome

[nzakas]

Yeah, nice start! I'd really like to get color in there as an accent, maybe blue? (Was thinking ESLint is purple, Espree being blue could make them look like they're related.)

[markphd]

Did some few changes. Here's some progress..

Still more to be done but I'd like to get some feedback from you.

@FredKSchott thanks!

[nzakas]

Really like the direction - the colors and typography are great. I even kind of like the logo. The only thing I'm not sure of is the splash image, doesn't quite seem right to me.

[markphd]

I really feel bad for not giving you update, will send one this weekend.

[nzakas]

That's okay, you can hold off. We might end up merging back into Esprima so this isn't a high priority at the moment.

[m1sta]

If espree continues on it's own it might make sense to highlight the differences to esprima very clearly and early on the homepage.

[xjamundx]

Can I build the demo page (similar to http://esprima.org/demo/parse.html)? I find myself needing this all the time and the esprima one is definitely lacking. Do we own espree.org or have a gh-pages branch it could live in for now?

[ilyavolodin]

If the only thing we want to add for now is espree parser, maybe we should just add it to eslint.org at least until we figure what we want to do with espree in the long run?

[nzakas]

Yeah, that makes sense.

[Announcement]

Are we still waiting on this or...?
Because if it is, I'll gladly take it! 😎

[nzakas]

@Announcement please feel free!

[nzakas]

Closing out old issues.