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

Docs should have "Quickstart" section. #534

Open
ralfbiedert opened this Issue Nov 20, 2018 · 5 comments

Comments

Projects
None yet
3 participants
@ralfbiedert
Copy link

ralfbiedert commented Nov 20, 2018

For someone who never used Zola, it takes a few tries to make it work.

There should be a quickstart page under https://www.getzola.org/documentation, that outlines these steps:

  • Install zola
  • Run zola init
  • Clone theme
  • create _index.md
  • Add +++ ... +++ hello world.
  • Run zola serve

Ideally step 3 (clone theme) should be possible to omit and still get a very basic result.

@Keats

This comment has been minimized.

Copy link
Collaborator

Keats commented Nov 20, 2018

Agreed, that's something I hope will come through user contribution as it already came up in #466
The only think I would change is de-emphasize themes as it really has some issues that are not trivial to fix vs just having the templates/css in the normal folders (#324 and #361)

@Bridouz

This comment has been minimized.

Copy link

Bridouz commented Nov 21, 2018

How about including a minimal starter theme like the one you're using for your blog ?

Zola's theming process could be scary for some users :)

@Keats

This comment has been minimized.

Copy link
Collaborator

Keats commented Nov 22, 2018

Most of my Zola sites are not blogs though

@Bridouz

This comment has been minimized.

Copy link

Bridouz commented Nov 22, 2018

Then a global starter theme :)

@Keats

This comment has been minimized.

Copy link
Collaborator

Keats commented Nov 29, 2018

Made an issue about that in the forum: https://zola.discourse.group/t/improve-documentation-first-time-experience/24

Then a global starter theme :)

Not as easy as it sounds :p

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment