-
Notifications
You must be signed in to change notification settings - Fork 31
Add website #212
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
Merged
Merged
Add website #212
Changes from all commits
Commits
Show all changes
27 commits
Select commit
Hold shift + click to select a range
440325b
Add website skeleton
tupui deebf5e
Merge branch 'main' into docs/website
tupui 2aed7e4
Some more plumbing
tupui 45cc34a
Cleanup on blogs and add first one
tupui d6a2dee
Add docs
tupui 2fa72cb
Add dependabot, CI for the website and adjustments on the other workf…
tupui ec6d659
Fix linters
tupui 806815c
Add generate command in CLI docs
tupui 87cb251
Update install to create-alias
tupui 9abf3e0
Refactor website to docs for GitHub Pages
tupui 93e13d5
Change deployment branch
tupui dcbb14f
Fix links
tupui c574c2a
Some other config
tupui b367a31
Fix base url
tupui a2d5531
Merge remote-tracking branch 'upstream/main' into docs/website
tupui ae1d7e6
Fix CI for docs
tupui 490dbdb
Fix linter
tupui 180a1b2
Quick-start and stellar smart contract
tupui 0b54ddc
Disable mode switch for now
tupui 2761d13
Soroban, stellar
tupui 62271fe
Add install button
tupui a1a3f87
Merge branch 'main' into docs/website
tupui d80f63d
Update docs/docusaurus.config.ts
tupui 10e76b9
Merge remote-tracking branch 'origin/docs/website' into docs/website
tupui 731b0b1
Various fixes, logos, dark mode-ish
tupui 04df1f4
Prod fixes
tupui 9b78ab3
Refactor docs to website
tupui File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| version: 2 | ||
| updates: | ||
| - package-ecosystem: github-actions | ||
| directory: / | ||
| schedule: | ||
| interval: weekly | ||
| groups: | ||
| actions-minor: | ||
| update-types: | ||
| - minor | ||
| - patch | ||
|
|
||
| - package-ecosystem: "npm" | ||
| directory: "/website" | ||
| schedule: | ||
| interval: "weekly" | ||
| groups: | ||
| npm-minor: | ||
| update-types: | ||
| - minor | ||
| - patch | ||
|
|
||
| - package-ecosystem: "cargo" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "weekly" | ||
| groups: | ||
| cargo-minor: | ||
| update-types: | ||
| - minor | ||
| - patch |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| name: Linting website | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| pull_request: | ||
| paths: | ||
| - 'website/**' | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| website-docs: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v5 | ||
|
|
||
| - name: Setup Bun | ||
| uses: oven-sh/setup-bun@v2 | ||
|
|
||
| - name: Get Bun cache directory | ||
| id: bun-cache-dir | ||
| run: echo "dir=$(bun pm cache)" >> ${GITHUB_OUTPUT} | ||
|
|
||
| - name: Cache Bun dependencies | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: | | ||
| ${{ steps.bun-cache-dir.outputs.dir }} | ||
| ~/.bun/install/cache | ||
| key: ${{ runner.os }}-bun-lint-${{ hashFiles('**/bun.lockb', '**/package.json', '**/bun.lock') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-bun-lint- | ||
| ${{ runner.os }}-bun- | ||
|
|
||
| - name: Install website dependencies | ||
| run: cd website && bun install --frozen-lockfile | ||
|
|
||
| - name: Check MDX | ||
| run: cd website && bun linter | ||
|
|
||
| - name: Build website | ||
| run: cd website && bun run build |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,3 +4,5 @@ target/ | |
| test_snapshots/ | ||
| .stellar/ | ||
| .vscode/ | ||
| .idea/ | ||
| .DS_Store | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| # Dependencies | ||
| /node_modules | ||
|
|
||
| # Production | ||
| /build | ||
|
|
||
| # Generated files | ||
| .docusaurus | ||
| .cache-loader | ||
|
|
||
| # Misc | ||
| .DS_Store | ||
| .env.local | ||
| .env.development.local | ||
| .env.test.local | ||
| .env.production.local | ||
|
|
||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| module.exports = { | ||
| ...require("@stellar/prettier-config"), | ||
| // This is mostly content, and prose wrap has a way of exploding markdown | ||
| // diffs. Override the default for a better experience. | ||
| overrides: [ | ||
| { | ||
| files: ["*.mdx", "*.md"], | ||
| options: { | ||
| proseWrap: "never", | ||
| }, | ||
| }, | ||
| ], | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # Website | ||
|
|
||
| This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| bun install | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Does this all work with npm or do you have to use bun? |
||
| ``` | ||
|
|
||
| ## Local Development | ||
|
|
||
| ```bash | ||
| bun start | ||
| ``` | ||
|
|
||
| This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. | ||
|
|
||
| ## Build | ||
|
|
||
| ```bash | ||
| bun run build | ||
| ``` | ||
|
|
||
| This command generates static content into the `build` directory and can be served using any static contents hosting service. | ||
|
|
||
| ## Deployment | ||
|
|
||
| ```bash | ||
| USE_SSH=true bun run deploy | ||
| ``` | ||
|
|
||
| We are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| --- | ||
| slug: hello-stellar | ||
| title: Welcome to Scaffold Stellar | ||
| authors: [tupui] | ||
| tags: [scaffold, official] | ||
| --- | ||
|
|
||
| We have a website! | ||
|
|
||
| Scaffold Stellar is getting its own website. You will be able to find our documentation, some tutorials and from time to time we will have guest blog posts showing how they use Scaffold in their projects. We are also thinking about setting up a gallery to show great projects from the community built with Scaffold. | ||
|
|
||
| Stay tuned! | ||
|
|
||
| <!-- truncate --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| tupui: | ||
| name: Pamphile Roy | ||
tupui marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| title: Principal Engineer at The Aha Company | ||
| url: https://linkedin.com/in/tupui | ||
| image_url: https://github.com/tupui.png | ||
| page: true | ||
| socials: | ||
| x: PamphileRoy | ||
| linkedin: tupui | ||
| github: tupui | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| scaffold: | ||
| label: Scaffold | ||
| permalink: /scaffold | ||
| description: Scaffold Stellar | ||
|
|
||
| official: | ||
| label: Official | ||
| permalink: /official | ||
| description: Official news about Scaffold Stellar |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this folder be
websiteor something to that effect? to avoiddocs/docspaths?