cortexjs.io

Repo ini berisi file sumber untuk situs web "Cortexjs.io".

Tl; dr

Pertama kali setelah mengkloning proyek atau setelah membuat beberapa perubahan sumber

git submodule init

git submodule update

# Setup, make a dev build and start a server
npm start

Untuk memperbarui dokumentasi setelah rilis baru

 # Pick-up changes in the dependent modules
npm run update

# Generate .md files for API and launch local server
npm start

Untuk menggelar dan menggunakan pembaruan

npm run stage
# Make a clean production build.
# Output goes inside submodules/cortex-js.github.io

npm run restart
# Validate that everything works well in the browser then...

npm run deploy
# submodules/cortex-js.github.io (a git submodule) gets pushed to cortex-js.github.io

Arsitektur

Situs ini diterbitkan menggunakan halaman GitHub. Manfaat utama menggunakan halaman GH adalah integrasi alur kerja (Pubshing to GH memicu pembaruan otomatis situs yang dilayani)

Konten situs ditulis terutama sebagai file markdown, diproses dengan eleventy untuk mengubahnya menjadi HTML/CSS.

Konfigurasi Main eleventy ada di file config/eleventy.js , termasuk definisi Markdown yang akan digunakan.

Mesin markdown adalah markdown-it yang mengimplementasikan CommonMark.

Plugin mardown-it-attrs memungkinkan gaya paragraf, misalnya

Ini adalah pemberitahuan. {.notice-Info}

Plugin markdown-it-deflist mendukung daftar definisi gaya PANDC:

 Term 1
:   Definition 1
:   Second definition

Outputnya ada di direktori submodules/cortex-js.github.io . Direktori itu adalah submodule git yang terkait dengan cortex-js.github.io repo. Repo itu adalah yang diterbitkan oleh Halaman GH (untuk organisasi, hanya seluruh repo yang dapat dipublikasikan, untuk proyek -proyek, isinya dapat terkandung dalam direktori A /docs ).

Lihat juga Submodules.

Repo cortex-js.github.io juga harus menyertakan dua file tambahan:

• .nojekyll yang menunjukkan kepada GitHub bahwa ia tidak boleh memproses konten repo ini dengan jekyll (karena ini sudah merupakan output dari jekyll)
• CNAME dengan konten cortexjs.io

File -file ini dibuat saat menjalankan npm run stage .

Gunakan tab Pengaturan di cortex-js.github.io repo untuk menunjukkan penggunaan domain khusus.

Selain itu, entri DNS untuk cortexjs.io harus menyertakan yang berikut:

• Catatan CName yang menunjuk ke www.cortex-js.io ke cortex-js.io
• Empat catatan yang menunjuk
  • 185.199.108.153
  • 185.199.109.153
  • 185.199.110.153
  • 185.199.111.153

Isi

Perintah npm run build menghasilkan dokumentasi untuk API dari file TypeScript .d.ts ke dalam build/ Directory.

Proses build menggunakan alat typedoc untuk mengurai file header API dan mengeluarkan file json di Direktori build/ .

CATATAN: Untuk men -debug konverter, gunakan vScode debugger. Pilih Debug> Mulai debugging untuk memulai sesi debugging tepat di vScode.

Script build-guides kemudian mengubah file json menjadi penurunan harga di direktori ./src/build , yang kemudian dapat diproses oleh Eleventy dengan npm run build atau npm start .

Informasi gaya CSS didefinisikan dalam src/_sass/ .

Dokumentasi API harus mengikuti Panduan Gaya Dokumentasi Google (https://developers.google.com/style/api-reference-comments) dan https://developers.google.com/style

Selain itu, kode TypeScript harus mengikuti panduan gaya Google: https://google.github.io/styleguide/jsguide.html#naming

Pengaturan dan skrip

Proyek ini mengikuti standar GitHub untuk penamaan skrip proyek.

Untuk melakukan bangunan lokal:

npm start

Untuk melakukan bangunan yang siap dipentaskan:

npm run stage

Tes

"Pengujian" dari situs yang dihasilkan terdiri dari pemeriksaan tautan, dan bahwa HTML yang dihasilkan valid.