Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Components of this project

Aperta
  • Qualcosa non va?
#2 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
20/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
jquery, nodejs, react, yaml
Ambito
documentation, tooling

Direzione di ricerca

Inizia con la opensgy-schema.yml proposta e verifica come si integrano il formato sorgente, il metodo di input, i parser, le destinazioni di rendering e gli obiettivi estesi dell’issue. Individua quali componenti rientrano nell’ambito e quali file o strumenti esistenti del progetto li gestiscono. Il lavoro è completato quando il progetto dispone di un’architettura dei componenti concordata e di un ambito di implementazione attuabile.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Here are what I see as the necessary components of the Open Styles project.

The Basics

  1. a source format/structure
  2. an entry method
  3. a parser for rendering output into HTML, PDF, Vale YAML, etc

For the source format, I am proposing YAML files that can be concatenated to make up a full listing. This means any tooling must be able to assemble the complete data object out of 1+ files. I hope the advantages of a flat-file database over an RDB are clear, as they enable source/version control and forking. My recommended "schema" is here.

For the entry method, we can obviously just edit YAML files, but we might consider repurposing a web interface like NetlifyCMS or another headless CMS that can be schemed to generate entry forms for YAML objects. That doesn't feel like a core part of the project, but it could be if people find the data format too overwhelming.

Finally, we will need to be able to generate new source files and rendered artifacts alike. My preference here is to go via AsciiDoc for HTML and PDF, so our templates can be used to build both HTML and PDF. We also need to parse rules into Vale or other linter formats. My go-to here is Liquid, which I've had some success teaching. But I also think we just need exemplary tooling, and this is simple enough that folks will create rendering systems through their preferred environments.

Nice-to-haves/Stretch Goals

  1. Front-end tools that recognize terms and present popovers, as I've done with my Jekyll theme's glossary. This is done in rudimentary jQuery, but it would be great to make it available under other frameworks or even just clean it up really good.

  2. Packaging (and maybe a renderer) that will excite front-end developers, which probably means NodeJS/npm on the back end and something modern like React or Vue on the front end.

What am I missing?

Lingua principale
Nessun dato sulla lingua
Stelle
7
Fork
1
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di DocOps/openstyles

Tutte le issue di DocOps/openstyles

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.