Compare commits
2 Commits
bdd972f2ea
...
15889989d0
| Author | SHA1 | Date | |
|---|---|---|---|
| 15889989d0 | |||
| 9fa52eaa15 |
136
README-old.md
Normal file
136
README-old.md
Normal file
@@ -0,0 +1,136 @@
|
|||||||
|
# ⚡ vite-plugin-cesium
|
||||||
|
|
||||||
|
[](https://www.npmjs.com/package/vite-plugin-cesium)
|
||||||
|
[](https://www.npmjs.com/package/vite-plugin-cesium)
|
||||||
|
|
||||||
|
Easily set up a [`Cesium`] project in [`Vite`].
|
||||||
|
|
||||||
|
[`cesium`]: https://github.com/CesiumGS/cesium
|
||||||
|
[`vite`]: https://github.com/vitejs/vite
|
||||||
|
|
||||||
|
**update：** if you just wanna a scaffolding by using this plugin, try a simply command `yarn create cesium`, click [create-cesium](https://www.npmjs.com/package/create-cesium) for more info.
|
||||||
|
|
||||||
|
Chinese tutorial: [中文教程](https://zhuanlan.zhihu.com/p/354856692)
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm i cesium vite-plugin-cesium vite -D
|
||||||
|
# yarn add cesium vite-plugin-cesium vite -D
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
add this plugin to `vite.config.js`
|
||||||
|
|
||||||
|
```js
|
||||||
|
import { defineConfig } from 'vite';
|
||||||
|
import cesium from 'vite-plugin-cesium';
|
||||||
|
export default defineConfig({
|
||||||
|
plugins: [cesium()]
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
add dev command to `package.json`
|
||||||
|
|
||||||
|
```json
|
||||||
|
"scripts": {
|
||||||
|
"dev": "vite",
|
||||||
|
"build": "vite build"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
run:
|
||||||
|
|
||||||
|
`yarn dev`
|
||||||
|
|
||||||
|
## Options
|
||||||
|
|
||||||
|
**rebuildCesium**
|
||||||
|
|
||||||
|
- **Type :** `boolean`
|
||||||
|
- **Default :** `false`
|
||||||
|
|
||||||
|
Default copy min cesium file to dist. if `true` will rebuild cesium from source.
|
||||||
|
|
||||||
|
```js
|
||||||
|
import { defineConfig } from 'vite';
|
||||||
|
import cesium from 'vite-plugin-cesium';
|
||||||
|
export default defineConfig({
|
||||||
|
plugins: [
|
||||||
|
cesium({
|
||||||
|
rebuildCesium: true
|
||||||
|
})
|
||||||
|
]
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## Demo
|
||||||
|
|
||||||
|
`src/index.js`
|
||||||
|
|
||||||
|
```js
|
||||||
|
import { Viewer } from 'cesium';
|
||||||
|
import './css/main.css';
|
||||||
|
|
||||||
|
const viewer = new Viewer('cesiumContainer');
|
||||||
|
```
|
||||||
|
|
||||||
|
> or if you like global Cesium object you can write as
|
||||||
|
|
||||||
|
```js
|
||||||
|
import * as Cesium from 'cesium';
|
||||||
|
const viewer = new Cesium.Viewer('cesiumContainer');
|
||||||
|
```
|
||||||
|
|
||||||
|
`index.html`
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>cesium-vite</title>
|
||||||
|
<script type="module" src="/src/index.js"></script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="cesiumContainer"></div>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
`src/css/main.css`
|
||||||
|
|
||||||
|
```css
|
||||||
|
html,
|
||||||
|
body,
|
||||||
|
#cesiumContainer {
|
||||||
|
width: 100%;
|
||||||
|
height: 100%;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Add `dev` and `build` commands to `package.json`
|
||||||
|
|
||||||
|
```
|
||||||
|
"scripts": {
|
||||||
|
"dev": "vite",
|
||||||
|
"build": "vite build"
|
||||||
|
},
|
||||||
|
```
|
||||||
|
|
||||||
|
Run `yarn dev`
|
||||||
|
|
||||||
|
For full demo project please check [./demo](https://github.com/nshen/vite-plugin-cesium/tree/main/demo) folder.
|
||||||
|
|
||||||
|
##
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT
|
||||||
141
README.md
141
README.md
@@ -79,144 +79,3 @@ export default defineConfig({
|
|||||||
],
|
],
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
以下是原仓库 README
|
|
||||||
|
|
||||||
# ⚡ vite-plugin-cesium
|
|
||||||
|
|
||||||
[](https://www.npmjs.com/package/vite-plugin-cesium)
|
|
||||||
[](https://www.npmjs.com/package/vite-plugin-cesium)
|
|
||||||
|
|
||||||
Easily set up a [`Cesium`] project in [`Vite`].
|
|
||||||
|
|
||||||
[`cesium`]: https://github.com/CesiumGS/cesium
|
|
||||||
[`vite`]: https://github.com/vitejs/vite
|
|
||||||
|
|
||||||
**update：** if you just wanna a scaffolding by using this plugin, try a simply command `yarn create cesium`, click [create-cesium](https://www.npmjs.com/package/create-cesium) for more info.
|
|
||||||
|
|
||||||
Chinese tutorial: [中文教程](https://zhuanlan.zhihu.com/p/354856692)
|
|
||||||
|
|
||||||
## Install
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm i cesium vite-plugin-cesium vite -D
|
|
||||||
# yarn add cesium vite-plugin-cesium vite -D
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
add this plugin to `vite.config.js`
|
|
||||||
|
|
||||||
```js
|
|
||||||
import { defineConfig } from 'vite';
|
|
||||||
import cesium from 'vite-plugin-cesium';
|
|
||||||
export default defineConfig({
|
|
||||||
plugins: [cesium()]
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
add dev command to `package.json`
|
|
||||||
|
|
||||||
```json
|
|
||||||
"scripts": {
|
|
||||||
"dev": "vite",
|
|
||||||
"build": "vite build"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
run:
|
|
||||||
|
|
||||||
`yarn dev`
|
|
||||||
|
|
||||||
## Options
|
|
||||||
|
|
||||||
**rebuildCesium**
|
|
||||||
|
|
||||||
- **Type :** `boolean`
|
|
||||||
- **Default :** `false`
|
|
||||||
|
|
||||||
Default copy min cesium file to dist. if `true` will rebuild cesium from source.
|
|
||||||
|
|
||||||
```js
|
|
||||||
import { defineConfig } from 'vite';
|
|
||||||
import cesium from 'vite-plugin-cesium';
|
|
||||||
export default defineConfig({
|
|
||||||
plugins: [
|
|
||||||
cesium({
|
|
||||||
rebuildCesium: true
|
|
||||||
})
|
|
||||||
]
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
## Demo
|
|
||||||
|
|
||||||
`src/index.js`
|
|
||||||
|
|
||||||
```js
|
|
||||||
import { Viewer } from 'cesium';
|
|
||||||
import './css/main.css';
|
|
||||||
|
|
||||||
const viewer = new Viewer('cesiumContainer');
|
|
||||||
```
|
|
||||||
|
|
||||||
> or if you like global Cesium object you can write as
|
|
||||||
|
|
||||||
```js
|
|
||||||
import * as Cesium from 'cesium';
|
|
||||||
const viewer = new Cesium.Viewer('cesiumContainer');
|
|
||||||
```
|
|
||||||
|
|
||||||
`index.html`
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!DOCTYPE html>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<meta charset="UTF-8" />
|
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<title>cesium-vite</title>
|
|
||||||
<script type="module" src="/src/index.js"></script>
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body>
|
|
||||||
<div id="cesiumContainer"></div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
```
|
|
||||||
|
|
||||||
`src/css/main.css`
|
|
||||||
|
|
||||||
```css
|
|
||||||
html,
|
|
||||||
body,
|
|
||||||
#cesiumContainer {
|
|
||||||
width: 100%;
|
|
||||||
height: 100%;
|
|
||||||
margin: 0;
|
|
||||||
padding: 0;
|
|
||||||
overflow: hidden;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Add `dev` and `build` commands to `package.json`
|
|
||||||
|
|
||||||
```
|
|
||||||
"scripts": {
|
|
||||||
"dev": "vite",
|
|
||||||
"build": "vite build"
|
|
||||||
},
|
|
||||||
```
|
|
||||||
|
|
||||||
Run `yarn dev`
|
|
||||||
|
|
||||||
For full demo project please check [./demo](https://github.com/nshen/vite-plugin-cesium/tree/main/demo) folder.
|
|
||||||
|
|
||||||
##
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
MIT
|
|
||||||
|
|||||||
Reference in New Issue
Block a user