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

First impressions #6

Open
Frosty-J opened this issue Oct 21, 2021 · 0 comments
Open

First impressions #6

Frosty-J opened this issue Oct 21, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@Frosty-J
Copy link

Frosty-J commented Oct 21, 2021

Hello! Now that I've got it working, I began making a page tonight. Here's some things I've noted in a few hours of use. May update the lists if there's anything else I think of.

I'm aware the project is still in its 0. release phase and you're nobody's slave, but some of this yourself or anyone else viewing this page mightn't have thought of. I might make the odd pull request if I continue using SPMW, but nothing major or controversial (stylistic changes in particular can be very opinionating).

Issues

  • Including a file that doesn't exist completely crashes SPMW, slowing down development if using it with --watch. It's also quite easy to crash by editing package.json.
  • Tags in headings break things (<q>Hello</q> becomes qhelloq in the anchor link, but hello in the heading ID, breaking the link).
  • Putting an unordered list inside an ordered one doesn't work correctly (instead of bullet points, the numbers just keep counting).
  • Putting an unordered list inside an unordered list doesn't change bullet point styles.
  • The tables implementation is unusual. Due to the requirement for vertical bars at the sides of each row and the lack of an example, I thought it wasn't working.
  • User-added CSS and JavaScript doesn't get minified.
  • CSS comments in included files can prevent page generation (I should test this further).
  • Internal navigation bar links get treated the same as external links (new tab and the little arrow).
  • I don't know if this is necessary, but adding color-scheme: light dark to :root might ensure system stuff such as checkboxes follow the theme. Haven't tried; my computer doesn't really do dark mode, and neither do I.
  • It's not very clear how to set it up, as I discussed in Could not resolve file: index.html #5.
  • JavaScript errors if there are no headings.
  • Referencing the same file multiple times causes problems (image.jpg in both the page content and share image result in it being saved as image-1.jpg, breaking the page href).
  • Spaces are missing between HTML attributes, causing about 100 errors depending on page size.

Wish list

  • A footer, such as for copyright info and social media links (so much padding feels odd without one).
  • Better support for custom CSS.
  • Support for strikethrough.
  • Support for codeblock syntax highlighting (would be a big pain to implement yourself - probably requires a library).
  • The ability to change the images filepath to something else, including leaving it blank for assets to be stored at the root directory.
  • A hook to run an external script after the page generates.
  • CSS for more tags such as <kbd> (I started making my own but it's not ready yet).
  • The ability to put a logo at the top-left of the page instead of the title in plaintext.
  • Animations for actions such as jumping to an anchor link, so long as they're fast and respect prefers-reduced-motion.
  • Links to not be nofollow by default, or at least an option to change this behaviour (it makes sense for user-generated content; not so much your own website).
  • YouTube embeds.
  • The option to change page language (not everyone writes in English).
  • The option to not minify the output (it's unhelpful during development, even if prettifiers exist).
  • Add light/dark mode toggle #2 - I agree a light/dark toggle and even a developer-set default would be good. Some types of content such as video simply lend themselves better to a darker theme, in my opinion.
  • Reversed external links on PC when sections is "true". The right-most link catches the eye by being at the end on PC, but the first link is the one you notice on mobile. It's difficult to order the links by importance for both layouts.

Good stuff

  • Page design is clean and to the point.
  • Anchor links are easy to copy and overall very cool.
  • Lightweight! I know we've come a long way since dial-up, but many templates are far heavier than need be.
  • Simplicity. Many site builders and whatnot have all sorts of bells and whistles, which is annoying if you're content with a simple page.
  • SEO. It has pretty much everything I'd add. Just missing a canonical tag, really.
@yuanqing yuanqing added the enhancement New feature or request label Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants