Comments (17)
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.
from espree.
@markphd thanks.
from espree.
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:
- About - basic information about the project
- Usage - how to use the API
- Developer guide - for contributors (likely similar to http://eslint.org/docs/developer-guide/)
- Demo - a demo page similar to http://esprima.org/demo/parse.html
- 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.
from espree.
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.
from espree.
WOAH! @markphd that mockup looks awesome
from espree.
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.)
from espree.
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!
from espree.
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.
from espree.
I really feel bad for not giving you update, will send one this weekend.
from espree.
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.
from espree.
If espree continues on it's own it might make sense to highlight the differences to esprima very clearly and early on the homepage.
from espree.
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?
from espree.
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?
from espree.
Yeah, that makes sense.
from espree.
Are we still waiting on this or...?
Because if it is, I'll gladly take it! 😎
from espree.
@Announcement please feel free!
from espree.
Closing out old issues.
from espree.
Related Issues (20)
- Please export `TokenTranslator` for reusing outside for ESLint plugins HOT 4
- Error parsing file starting with '#!/usr/bin/env node' HOT 2
- support import assertions HOT 1
- as token type: Identifier -> Punctuator HOT 3
- How to use from a script tag? HOT 1
- Not able to access parent node from current node. HOT 2
- Set up release-please HOT 1
- Set up scripts/lint-staged to match those in eslint repo HOT 3
- remove sourcemap url HOT 7
- typing for parse() HOT 1
- Support for `using` keyword HOT 1
- # ⚠️ npm 6.x no extra double-dash: npm init @eslint/config --config semistandard HOT 2
- add npm install step to release-please workflow (#573) (d8900c1) run tests on Node.js v20 (#571) (adf478e) set up release-please (#569) (abda10f) upgrade [email protected] (#574) (8e73f11) HOT 1
- Invalid regular expression flag HOT 2
- 9 Failing tests on project install HOT 1
- espree improvements as an acorn plugin extension [RFC] HOT 1
- Is it possible to configure tokenize method to return hyphenated word as one token? HOT 1
- Not ES2020 HOT 1
- Convert into monorepo HOT 16
- Change Request: replace `npm-run-all` by `npm-run-all2` HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from espree.