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

feat: migrate frontend framework from mdbook to vocs #185

Merged
merged 4 commits into from
Oct 3, 2024

Conversation

kushagrasarathe
Copy link
Contributor

Issue(s): Closes #167

Description

Frontend migrated from mdbook to vocs

@julio4 julio4 changed the base branch from main to vocs May 23, 2024 07:04
Copy link
Member

@julio4 julio4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great! Is there a reason why you moved the listings directory to docs/snippets?
Default rootDir is ./docs, but it can be changed in vocs.config.ts. You should try to change it torootDir: '.' and see if we can keep listings and docs separated.

That way we can import the repository either as a scarb project (listings) or as a vocs project (docs)

.tool-versions Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
scripts/cairo_programs_verifier.sh Outdated Show resolved Hide resolved
docs/pages/index.mdx Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
docs/pages/ch00/basics/constructor.md Outdated Show resolved Hide resolved
@kushagrasarathe kushagrasarathe requested a review from julio4 May 24, 2024 08:15
@julio4 julio4 merged commit 261b110 into NethermindEth:vocs Oct 3, 2024
julio4 pushed a commit to julio4/StarknetByExample that referenced this pull request Oct 25, 2024
* feat: migration to vocs

* Update CONTRIBUTING.md

* Update README.md

* fix: pr review requested changes
julio4 added a commit that referenced this pull request Nov 15, 2024
* feat: migrate frontend framework from mdbook to vocs  (#185)

* feat: migration to vocs

* Update CONTRIBUTING.md

* Update README.md

* fix: pr review requested changes

* temp: remove pages

* chore: Anchors in listings

* feat: voc sidebar config

* feat: migrate listings and book to vocs

* chore: npm -> pnpm

* ci/cd: fix build

* feat: footer

* feat: add tailwindcss

* feat: styling and configuration

* feat: mathjax support

* feat: collapsible sidebar css

* ci/cd: remove mdbook workflow

* feat: cairo syntax hl

* style: minor improvements

* fix: mdbook leftover anchors

* feat: collapsible sidebar

* feat: themes, inline highlighting, minor fixes

* ci/cd: add .npmrc file

---------

Co-authored-by: Kushagra Sarathe <76868364+kushagrasarathe@users.noreply.github.com>
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

Successfully merging this pull request may close these issues.

Improvement: Migrating to vocs static site generator
2 participants