Comments (6)
Hi, i would like it to be assigned to me...
from starknet-docs-antora-ui.
@vibenedict I'd love for you to take this, but before I assign it to you, are you familiar with Antora, and with how updates to Antora UI projects work?
from starknet-docs-antora-ui.
@stoobie I know Antora but I haven't used it to any project before but it is something I can get familiar with in no time.
from starknet-docs-antora-ui.
Hey @vibenedict , OK, I assigned it to you. Be aware that the README needs some work.
As far
Some tips I can give you to get started:
- The README is essentially the same README as the default Antora UI project.
- The only changes I recall making are to specify the commands for previewing the UI project and building the bundle after you clone the project to your local environment. The commands I added work in my local environment.
- Feel free to update the readme while you're working to add any other helpful info that I didn't get around to.
- The files containing the AsciiDoc that appears in the browser when you preview the site are located in /preview-src. I generally just add a new section to index.adoc with what I want to test.
- You can use this AsciiDoc code to test the description list:
[horizontal,labelwidth="30",role=stripes-odd]
`address _token_`::
The address of the contract for the desired token.
`uint256 _amount_`::
The amount of the deposit.
`uint256 _l2Recipient_`::
The L2 address of the recipient.
- After I have the changes working in the preview, I build a ui_bundle.zip file (
yarn build
) and push it to the PR, and then create a new PR in the Starknet-docs repo to test the changes. For an example of the change I made in playbook.yml for testing, see https://github.com/starknet-io/starknet-docs/pull/1165/files.
Let me know if you have any questions.
from starknet-docs-antora-ui.
Hi @vibenedict Any update on this?
from starknet-docs-antora-ui.
Hi @stoobie almost done in a couple of days it will be ready... I am facing some challenges fixing the CSS at the moment.
from starknet-docs-antora-ui.
Related Issues (2)
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from starknet-docs-antora-ui.