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

[web] Switch to vuepress from nuxt.js #52

Closed
at15 opened this issue Apr 18, 2018 · 4 comments
Closed

[web] Switch to vuepress from nuxt.js #52

at15 opened this issue Apr 18, 2018 · 4 comments
Assignees
Projects

Comments

@at15
Copy link
Member

at15 commented Apr 18, 2018

Currently the website is built using https://github.com/nuxt/nuxt.js, however the author of vue released a similar tool https://github.com/vuejs/vuepress

Reason for making the switch

  • I forgot how to use nuxt.js since it's been so long for PR [Abandoned] Store data in database #41 , since I have to learn nuxt.js again if I am going to use it, I'd rather learn vuepress
  • angular universal is not usable, and it seems few attention is paid into it
  • vuepress has
    • builtin markdown support
    • theme for building documentation site
@koppor
Copy link

koppor commented Apr 25, 2018

Besides, I would think to switch to plain markdown. This allows for inclusion in the awesome list. See point 3 of the checklist at https://github.com/sindresorhus/awesome/blob/master/pull_request_template.md#requirements-for-your-awesome-list. Since this is the most popular list of awesome lists, it is IMHO a worthy aim.

Besides that, the list could be easily included in the definitive lists of lists at https://github.com/jnv/lists.

@at15
Copy link
Member Author

at15 commented Apr 25, 2018

@koppor I was thinking about using plain markdown like most awesome-lists, but a very long markdown file is hard to filter based on multiple properties.

It is also possible to only generate website and maintain the README.md file manually. I'll start sorting things out this week and adding sections for papers and benchmarks.

@koppor
Copy link

koppor commented Apr 25, 2018

This somehow refs sindresorhus/awesome#784 (comment).

at15 added a commit that referenced this issue Feb 10, 2019
- using default theme for now
at15 added a commit that referenced this issue Feb 10, 2019
at15 added a commit that referenced this issue Jan 7, 2020
Replace nuxt.js with vuepress #52 

- Add license field #34 

The website supports more filter, and the implementation is no longer hard coded, there is a schema defined in javascript and can be checked using `make check`

REAMD.md file is now partially generated `make generate`, a markdown table is injected and other content can be edited by human directly as long as you don't touch the magic comment used by regular expression (poor man's template)

Each database now has its own page e.g. https://awesome-time-series-database.netlify.com/database/akumuli.html Except the vue component, it's plain markdown and people can say whatever they want (marketing stuff like fastest tsdb ...) I am thinking about a common layout for people (at least myself) to recap what's special about a tsdb (e.g. storage format, compression)
@at15 at15 added this to DOING in Website Jan 9, 2020
@at15
Copy link
Member Author

at15 commented Jan 9, 2020

Already finished the switch and dealing with all the open issues for adding database now.

Vuepress has built in search and you can do filter based on properties of databases (e.g. status (half of them are dead already ...).

Will add benchmark, papers and link them with databases later.

@at15 at15 closed this as completed Jan 9, 2020
Website automation moved this from DOING to DONE Jan 9, 2020
@at15 at15 self-assigned this Jan 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Website
  
DONE
Development

No branches or pull requests

2 participants