Skip to content

jaywcjlove/nginx-editor

Repository files navigation

nginx-editor

Buy me a coffee Build & Deploy Issues Forks Stars Open in unpkg npm version

Nginx language plugin for the Monaco Editor. It provides the following features when editing Nginx config files:

  • Syntax highlighting

Quick Start

npm install monaco-editor-nginx

Open in CodeSandbox Open in Github gh-pages

import MonacoEditor from '@uiw/react-monacoeditor';
import 'monaco-editor-nginx';

<MonacoEditor
  ref={editor}
  theme={theme === 'vs-dark' ? 'nginx-theme-dark' : 'nginx-theme'}
  onChange={(value) => {
    setContentDownload(value);
  }}
  language="nginx"
  value={content}
  height="calc(100vh - 36px)"
/>

or, Integrating the ESM version of the Monaco Editor

import * as monaco from 'monaco-editor';
import 'monaco-editor-nginx';

monaco.editor.create(document.getElementById("container"), {
  theme: 'nginx-theme',
  value: 'nginx code.....',
  language: 'nginx'
});

Development

Warning

Using npm to install now cannot preview the example effect, but using yarn@1 works. Currently, we are not sure what the reason is. If anyone knows, please let me know. Thanks a lot 🙏

yarn install # ⚠️ 

Runs the project in development mode.

# Step 1, run first, listen to the component compile and output the .js file
# listen for compilation output type .d.ts file
npm run watch
# Step 2, development mode, listen to compile preview website instance
npm run start

Builds the app for production to the build folder.

npm run build

The build is minified and the filenames include the hashes. Your app is ready to be deployed!

Related

Contributors

As always, thanks to our amazing contributors!

Made with github-action-contributors.

License

Licensed under the MIT License.