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

question: can we use verso by simply adding require verso to the lakefile? #77

Open
Seasawher opened this issue Apr 13, 2024 · 1 comment

Comments

@Seasawher
Copy link

I would like to ask a question about how users can use verso to write documents.

1A. When a user tries to write a document using the verso, do they need to clone the verso code and add their articles to a specific directory ?

2A. Can the verso syntax and commands for outputting HTML be made available simply by adding a dependency on verso to the lakefile?

2A would be more user-friendly; if not 2A, is it possible to make it like 2A?

I apologise if I have been careless and have missed the written explanation.

@Seasawher Seasawher changed the title question: can we use this by simply adding require verso to the lakefile? question: can we use verso by simply adding require verso to the lakefile? Apr 13, 2024
@david-christiansen
Copy link
Collaborator

No, there's no explanation yet to miss :-)

One difference between Verso and most documentation tools is that Verso isn't really a tool per se - it's a library for building a documentation tool that closely integrates with Lean. This is because different kinds of documents have different needs, and no single tool will serve them all well - mdbook would be a poor fit for blogging, for instance.

The way you'll use Verso, once it makes a bit more progress, is to pick one of the tools implemented with it and then follow that tool's instructions. For now, there's an examples directory that you can refer to, but things are still in flux and not quite ready for general use.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants