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

new site #1036

Merged
merged 32 commits into from
Jun 13, 2021
Merged

new site #1036

merged 32 commits into from
Jun 13, 2021

Conversation

akellbl4
Copy link
Collaborator

@akellbl4 akellbl4 commented Jun 6, 2021

I've redeveloped the site with Eleventy. It's an alternative for Hugo with a much friendly API and DX.
Finally, we've got working navigation in docs.

Live demo

Fixes #1013

  • implement 404 page
  • implement theme switcher
  • implement dark theme
  • add code highlighting
  • mobile version for docs
  • fix styles for a dark theme when having all of the content

Maybe features down below better do in separate PR and release new site sooner.

  • add links on next/prev pages at the end of doc pages
  • add a table of content
  • implement a page with a list of the releases
  • add copy button on code blocks
Screenshots CleanShot 2021-06-12 at 15 35 14@2x CleanShot 2021-06-12 at 15 35 11@2x CleanShot 2021-06-12 at 15 19 26@2x CleanShot 2021-06-13 at 11 10 34@2x CleanShot 2021-06-13 at 11 10 37@2x CleanShot 2021-06-13 at 11 10 40@2x

@akellbl4 akellbl4 added the site label Jun 6, 2021
@akellbl4 akellbl4 requested review from paskal and Mavrin June 6, 2021 20:42
@akellbl4
Copy link
Collaborator Author

akellbl4 commented Jun 6, 2021

@paskal I've created a structure of content. If you have any ideas we can change it.

@codecov
Copy link

codecov bot commented Jun 6, 2021

Codecov Report

Merging #1036 (3ee350d) into master (4f0002a) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1036   +/-   ##
=======================================
  Coverage   44.18%   44.18%           
=======================================
  Files         126      126           
  Lines        2904     2904           
  Branches      653      653           
=======================================
  Hits         1283     1283           
  Misses       1609     1609           
  Partials       12       12           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d616798...3ee350d. Read the comment docs.

@github-actions
Copy link

github-actions bot commented Jun 6, 2021

size-limit report 📦

Path Size
public/embed.mjs 2.23 KB (0%)
public/remark.mjs 65.26 KB (0%)
public/remark.css 9.41 KB (0%)
public/last-comments.mjs 30.06 KB (0%)
public/last-comments.css 5.07 KB (0%)
public/deleteme.mjs 9.76 KB (0%)
public/counter.mjs 601 B (0%)

@akellbl4 akellbl4 force-pushed the site branch 2 times, most recently from d41f9dc to d08a8b5 Compare June 6, 2021 20:53
site/.dockerignore Show resolved Hide resolved
site/Dockerfile Outdated Show resolved Hide resolved
@akellbl4
Copy link
Collaborator Author

akellbl4 commented Jun 11, 2021

@paskal thank you for your help!

@paskal
Copy link
Sponsor Collaborator

paskal commented Jun 12, 2021

Really nice site! Few things I found so far:

  • Main page has extra empty <li> element
    image
  • /docs/system-requirments/ should be /docs/system-requirements/, also edit button leads to https://github.com/umputun/remark42/edit//src/docs/getting-started/system-requirments/index.md with two slashes, one is redundant
  • in my case, docker-compose run build generates the site properly, but docker-compose up server serves the site without style.css
  • Right now, the site generated with docker-compose run build is empty, current documentation is not included: what I see is plenty of empty pages, /docs/contributing/technical-details/ is the only one I found with text.
  • code on the only page with text I have is wrapped in apostrofs
    image
  • The 404 page you designed is not shown on the yarn dev run. For consistency, I would propose fixing that as well.

@akellbl4
Copy link
Collaborator Author

akellbl4 commented Jun 13, 2021

but docker-compose up server serves the site without style.css

Strange works well for me.

Right now, the site generated with docker-compose run build is empty, current documentation is not included: what I see is plenty of empty pages, /docs/contributing/technical-details/ is the only one I found with text.

I've created a proper structure for docs but haven't moved them to the site yet.
If anybody can help with it would be great.

code on the only page with text I have is wrapped in apostrofs

They are backticks and it's intentional. I use default styles for it from tailwind.

The 404 page you designed is not shown on the yarn dev run. For consistency, I would propose fixing that as well.

As far as I know, dev server doesn't support custom 404 and it can be reached by open /404/. In production, configuration should refer to that page for displaying 404

@akellbl4
Copy link
Collaborator Author

  • Main page has extra empty <li> element
image

I've fixed this bug. It was bad support for the dark theme on the main page.

@akellbl4
Copy link
Collaborator Author

Live demo:
https://remark42.vercel.app/

@akellbl4
Copy link
Collaborator Author

akellbl4 commented Jun 13, 2021

/docs/system-requirments/ should be /docs/system-requirements/, also edit button leads to https://github.com/umputun/remark42/edit//src/docs/getting-started/system-requirments/index.md with two slashes, one is redundant

Fixed

@akellbl4 akellbl4 marked this pull request as ready for review June 13, 2021 11:37
@akellbl4 akellbl4 requested a review from umputun as a code owner June 13, 2021 11:37
@akellbl4
Copy link
Collaborator Author

@paskal try to run the server in docker. looks like I've fixed it.

@akellbl4 akellbl4 requested a review from paskal June 13, 2021 12:12
@akellbl4
Copy link
Collaborator Author

akellbl4 commented Jun 13, 2021

@paskal @umputun @Mavrin
I've done everything from the code perspective. Feel free to test and comment. Check out the live demo
I think this PR is good to merge. I created a basic structure for docs to demonstrate how navigation works. We can do all of the work on migration docs in a separate PR.

@umputun umputun merged commit cd34238 into master Jun 13, 2021
@umputun umputun deleted the site branch June 13, 2021 22:40
@umputun umputun restored the site branch June 13, 2021 23:15
@umputun umputun mentioned this pull request Jun 13, 2021
@umputun umputun deleted the site branch June 13, 2021 23:44
@paskal paskal added this to the v1.9 milestone Jan 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Get rid of documentation versioning
3 participants