bitrock website

Bitrock-Website

Situs web ini adalah instance Vuepress dengan tema khusus yang diterapkan di atasnya, Anda dapat membaca dokumentasi resmi untuk mempelajari cara mengedit konten atau cara kerja tema.

Persyaratan

Anda memerlukan perangkat lunak berikut yang diinstal di mesin Anda untuk memulai:

• Node.js stabil terbaru
• Manajer Paket YARN Keduanya dapat diinstal melalui homebrew di lingkungan macOS & Linux.

Menciptakan lingkungan pengembangan lokal

Klon repo secara lokal

$ git clone [email protected]:bitrockteam/bitrock-website.git

Pindah ke folder dan pasang dependensi dengan benang

$ cd bitrock-website && yarn

Mulailah server web pengembangan di localhost:8080

$ yarn start

Penulisan

Konten disediakan melalui file Markdown di folder ./src , tidak ada editor visual bawaan sehingga dapat ditulis di mana pun Anda inginkan, tetapi secara berurutan. Komponen VUE didukung dalam konten Markdown dan dapat dipertimbangkan untuk menambahkan beberapa komponen khusus untuk memungkinkan penulis dengan kemampuan tambahan. Metadata disediakan menggunakan spesifikasi frontmatter.

Tambahkan halaman

Buat subfolder di jalur ./src dan kemudian buat file readme.md di dalamnya, di atas file tambahkan data berikut:

---
layout : Page
---

Contoh : file ./src/about-us/readme.md akan menjadi halaman https://bitrock.it/about-us .

Untuk menambahkan halaman di menu navigasi ./src/.vuepress/config.js harus diperbarui.

Tambahkan posting blog

Buat subfolder di jalur ./src/blog dan kemudian buat file readme.md di dalamnya, di atas file tambahkan data berikut:

---
title : Hello world!
image : /img/hello.jpg
author : writer
publish : 2018-12-21
layout : Post
category : news
tags :
  - greetings
  - hello
---

Contoh ./src/blog/hello-world/readme.md https://bitrock.it/blog/hello-world

Posting akan ditampilkan pada urutan reversed-kronologis (terbaru pertama) di halaman utama.

Gambar

Gambar di seluruh situs harus ditambahkan di folder ´. Perhatikan bahwa jika Anda menambahkan gambar dalam folder pos atau halaman, itu tidak akan dapat dijangkau di luar URL halaman menggunakan jalur relatif.

Tidak ada proses optimasi otomatis jadi hati -hati pada ukuran gambar yang Anda terbitkan.

Perkembangan

Semua file sumber pengembangan terletak di dalam folder ./src/.vuepress/theme .

./src/.vuepress/public adalah tempat untuk menempatkan segala jenis aset yang perlu tersedia sebagai sumber daya statis pada tingkat akar domain penyebaran. Subfolder akan dilestarikan.

Plugin Vuepress

• @vuepress/plugin-google-analytics yang memberikan ID pemantauan Google Analytics, itu akan menyuntikkan pada halaman kode yang diperlukan.
• @vuepress/plugin-pwa itu menghasilkan pekerja layanan pada pemetaan fase build semua aset statis untuk caching offline. Ini tidak akan menghasilkan WebManifest yang diperlukan untuk memicu fungsionalitas PWA, yang ditulis secara manual dan disajikan di folder publik.
• @vuepress/plugin-back-to-top itu cukup tambahkan tombol belakang ke panah atas setelah menggulir sedikit dari viewport awal.
• @Vuepress/nProgress menambahkan bilah kemajuan di atas halaman saat memuat konten baru, mirip dengan apa yang terjadi di YouTube.

JS Utilities

Ketergantungan utama di sini adalah perpustakaan vue.js yang digunakan untuk membangun komponen, yang lainnya adalah vanilla javascript.

Utilitas CSS

Kami menggunakan perpustakaan CSS ini:

• Normalize.CSS membuat browser membuat semua elemen lebih konsisten dan sejalan dengan standar modern.
• typeBase.css titik awal untuk tipografi web.
• Hamburgers menu hamburger animasi CSS.

Kebijakan bercabang

Proyek ini mengikuti kebijakan percabangan sederhana:

• master hanya berisi kode yang stabil, dan tidak boleh diperbarui secara langsung
• development di mana kode berevolusi atau eksperimental ditulis
• gh-pages di mana file statis yang dapat didistribusikan digunakan tetapi ** Anda harus menghindari untuk langsung berkomitmen/mendorong di sini **

Jangan bergabung secara langsung development menjadi master ( itu dikunci admin ... ), selalu kirim PR untuk memiliki ulasan.

Perbarui & Menyebarkan

Setiap kali cabang master diperbarui (komit langsung atau pr), pekerjaan travis ci baru dipicu dan terdiri dari langkah -langkah ini:

1. instal dependensi
2. Vuepress Membangun situs web dengan semua file terkait di /dist
3. Jika build berhasil, folder /dist maka digunakan pada halaman github
4. Deploy baru tersedia di BitRock.it

Ada skrip NPM yang tersedia untuk digunakan secara manual di Cabang gh-pages dari mesin lokal Anda (Anda harus terlebih dahulu membangun proyek secara lokal):

$ yarn gh:pages

Tapi tolong gunakan hanya jika benar -benar dibutuhkan.

Lisensi

Logo grup databiz, bitrock dan radicalbit adalah merek dagang terdaftar. Kode didistribusikan di bawah lisensi GNU AGPLV3. Foto stok yang disertakan telah disediakan oleh Unsplash.