Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated readme #17

Merged
merged 1 commit into from
Dec 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 34 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,37 @@
# OpenPress

OpenPress is a web application designed to enhance note-taking and article writing experiences. With a user-friendly interface and powerful features, OpenPress aims to provide a seamless platform for users to organize their thoughts, create detailed notes, and write compelling articles.

## Key Features

- **Intuitive Note Taking**: OpenPress offers a simple and intuitive note-taking interface, allowing users to quickly jot down their ideas and thoughts.
- **Rich Text Editing**: With OpenPress, users can format their notes and articles using a variety of styling options, including bold, italic, headings, lists, and more.
- **Collaboration**: OpenPress supports collaboration, enabling multiple users to work together on the same document in real-time, making it ideal for team projects or group discussions.
- **Tagging and Categorization**: Users can easily organize their notes and articles by assigning tags and categories, making it effortless to find and retrieve information later.

## Getting Started

To start using OpenPress, follow these steps:

1. Install the necessary dependencies by running `npm install` in the project directory.
2. Launch the development server by running `npm run dev`.
3. Access OpenPress in your web browser at `http://localhost:5173`.

For more information and customization options, refer to the [Vite Configuration Reference](https://vitejs.dev/config/).

## Requirements

- Node.js (v14 or higher)
- npm (v6 or higher)

## Contributing

We welcome contributions from the community! If you'd like to contribute to OpenPress, please refer to our [contribution guidelines](CONTRIBUTING.md) for more information.

## License

OpenPress is released under the [MIT License](LICENSE).

This template should help get you started developing with Vue 3 in Vite.

## Recommended IDE Setup
Expand All @@ -13,8 +45,8 @@ TypeScript cannot handle type information for `.vue` imports by default, so we r
If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:

1. Disable the built-in TypeScript Extension
1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.

## Customize configuration
Expand Down Expand Up @@ -50,4 +82,3 @@ npm run test:unit
```sh
npm run lint
```
# openpress
7 changes: 6 additions & 1 deletion src/components/global/CustomDialog.vue
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,12 @@ defineEmits(['close-dialog'])
<div class="custom-dialog">
<div class="custom-dialog-header">
<slot name="header"></slot>
<span class="material-symbols-outlined close ms-auto" data-test="close" @click="$emit('close-dialog')">cancel</span>
<span
class="material-symbols-outlined close ms-auto"
data-test="close"
@click="$emit('close-dialog')"
>cancel</span
>
</div>
<div class="custom-dialog-body" data-test="body-slot">
<slot name="body"></slot>
Expand Down
2 changes: 1 addition & 1 deletion src/views/HomeView.vue
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ onMounted(() => {

<template>
<div class="d-flex h-100">
<div class="h-100 first-pane">Hi</div>
<div class="h-100 first-pane"></div>
<div class="h-100 flex-grow-1">
<div class="row h-100 g-0">
<div class="col-lg-2 h-100 second-pane">
Expand Down
Loading