Di dalam AstroPaper, Anda akan melihat folder dan file berikut:
/
├── public/
│ ├── assets/
│ │ └── logo.svg
│ │ └── logo.png
│ └── favicon.svg
│ └── astropaper-og.jpg
│ └── robots.txt
│ └── toggle-theme.js
├── src/
│ ├── assets/
│ │ └── socialIcons.ts
│ ├── components/
│ ├── content/
│ │ | blog/
│ │ | └── some-blog-posts.md
│ │ └── config.ts
│ ├── layouts/
│ └── pages/
│ └── styles/
│ └── utils/
│ └── config.ts
│ └── types.ts
└── package.json
Astro mencari file .astro
atau .md
di direktori src/pages/
. Setiap halaman diekspos sebagai rute berdasarkan nama filenya.
Aset statis apa pun, seperti gambar, dapat ditempatkan di direktori public/
.
Semua posting blog disimpan di direktori src/content/blog
.
Dokumentasi dapat dibaca dalam dua format_ penurunan harga & postingan blog .
Untuk AstroPaper v1, lihat cabang ini dan URL langsung ini
Kerangka Utama - Astro
Pemeriksaan Ketik - TypeScript
Kerangka Komponen - ReactJS
Penataan - TailwindCSS
UI/UX - File Desain Figma
Pencarian Fuzzy - FuseJS
Ikon - Kotakikon | Tabel
Pemformatan Kode - Lebih Cantik
Penerapan - Halaman Cloudflare
Ilustrasi di Halaman Tentang - https://freesvgillustration.com
Linting - ESLint
Anda dapat mulai menggunakan proyek ini secara lokal dengan menjalankan perintah berikut di direktori yang Anda inginkan:
# npm 6.x
npm create astro@latest --template satnaing/astro-paper
# npm 7+, extra double-dash is needed:
npm create astro@latest -- --template satnaing/astro-paper
# yarn
yarn create astro --template satnaing/astro-paper
# pnpm
pnpm dlx create-astro --template satnaing/astro-paper
Peringatan! Jika Anda menggunakan
yarn 1
, Anda mungkin perlu menginstalsharp
sebagai ketergantungan.
Kemudian mulai proyek dengan menjalankan perintah berikut:
# install dependencies
npm run install
# start running the project
npm run dev
Sebagai pendekatan alternatif, jika Anda telah menginstal Docker, Anda dapat menggunakan Docker untuk menjalankan proyek ini secara lokal. Begini caranya:
# Build the Docker image
docker build -t astropaper .
# Run the Docker container
docker run -p 4321:80 astropaper
Anda dapat dengan mudah menambahkan tag HTML Verifikasi Situs Google di AstroPaper menggunakan variabel lingkungan. Langkah ini opsional. Jika Anda tidak menambahkan variabel lingkungan berikut, tag verifikasi situs Google tidak akan muncul di bagian HTML <head>
.
# in your environment variable file (.env)
PUBLIC_GOOGLE_SITE_VERIFICATION=your-google-site-verification-value
Lihat diskusi ini untuk menambahkan AstroPaper ke Google Search Console.
Semua perintah dijalankan dari root proyek, dari terminal:
Catatan! Untuk perintah
Docker
kami harus menginstalnya di mesin Anda.
Memerintah | Tindakan |
---|---|
npm install | Menginstal dependensi |
npm run dev | Memulai server pengembang lokal di localhost:4321 |
npm run build | Bangun situs produksi Anda ke ./dist/ |
npm run preview | Pratinjau build Anda secara lokal, sebelum diterapkan |
npm run format:check | Periksa format kode dengan Prettier |
npm run format | Format kode dengan Prettier |
npm run sync | Menghasilkan tipe TypeScript untuk semua modul Astro. Pelajari lebih lanjut. |
npm run lint | Lint dengan ESLint |
docker compose up -d | Jalankan AstroPaper di buruh pelabuhan, Anda dapat mengakses dengan nama host dan port yang sama yang diinformasikan pada perintah dev . |
docker compose run app npm install | Anda dapat menjalankan perintah apa pun di atas ke dalam wadah buruh pelabuhan. |
docker build -t astropaper . | Bangun image Docker untuk AstroPaper. |
docker run -p 4321:80 astropaper | Jalankan AstroPaper di Docker. Situs web dapat diakses di http://localhost:4321 . |
Peringatan! Pengguna Windows PowerShell mungkin perlu menginstal paket secara bersamaan jika mereka ingin menjalankan diagnostik selama pengembangan (
astro check --watch & astro dev
). Untuk informasi lebih lanjut, lihat masalah ini.
Jika Anda memiliki saran/masukan, Anda dapat menghubungi saya melalui email saya. Alternatifnya, jangan ragu untuk membuka masalah jika Anda menemukan bug atau ingin meminta fitur baru.
Berlisensi di bawah Lisensi MIT, Hak Cipta © 2023
Dibuat dengan? oleh Sat Naing ?? dan kontributor.